Import a code book specification from a spreadsheet

Usage

codebook_fromSpreadsheet(
  x,
  localBackup = NULL,
  exportGoogleSheet = TRUE,
  xlsxPkg = c("rw_xl", "openxlsx", "XLConnect"),
  silent = rock::opts$get("silent")
)

Arguments

x: The URL or path to a file.
localBackup: If not NULL, a valid filename to write a local backup to.
exportGoogleSheet: If x is a URL to a Google Sheet, instead of using the googlesheets4 package to download the data, by passing exportGoogleSheet=TRUE, an export link will be produced and the data will be downloaded as Excel spreadsheet.
xlsxPkg: Which package to use to work with Excel spreadsheets.
silent: Whether to be silent or chatty.

Value

The code book specification as a rock code book object

Examples

### Note that this will require an active
### internet connection! This if statement
### checks for that.
# \donttest{
if (tryCatch({readLines("https://google.com",n=1); TRUE}, error=function(x) FALSE)) {

  ### Read the example ROCK codebook
  gs_url <- paste0(
    "https://docs.google.com/spreadsheets/d/",
    "1gVx5uhYzqcTH6Jq7AYmsLvHSBaYaT-23c7ZhZF4jmps"
  );
  ROCK_codebook <- rock::codebook_fromSpreadsheet(gs_url);

  ### Show a bit
  ROCK_codebook$metadata[1:3, ];
}
#> Error in rock::read_spreadsheet(x = x, localBackup = localBackup, exportGoogleSheet = exportGoogleSheet,     xlsxPkg = xlsxPkg, silent = silent): To read Excel spreadsheets (`.xlsx`), the {readxl} package has to be installed. You can install it with:
#> 
#>   install.packages('readxl');
# }