R/sheet_download.R

In lter/soilHarmonization: Homogenize LTER Soil Organic Matter Working Group data and notes

#' @title Import a Google Sheet
#'
#' @description The sheet_download function downloads the contents of a Google
#'   Sheet into an R object with with optional parameters for rows to skip and a
#'   missing value code upon import.
#'
#' @note sheet_download is intended primarily as a helper function for batch
#'   downloading Google Sheets via a apply or map call but can be used
#'   independently.
#'
#' @param fileId Sheet ID or URL of Google Sheet to import
#' @param skipRows number of rows to skip when importing (optional; default:0)
#' @param missingValueCode string to denote missing values (optional;
#'   default:"NA")
#'
#' @importFrom googlesheets4 read_sheet
#'
#' @return R object of type tibble
#'
#' @export
#'

sheet_download <- function(fileId, skipRows, missingValueCode) {

  if (missing(skipRows)) {

    skipRows <- 0

  }

  if (missing(missingValueCode)) {

    missingValueCode <- "NA"

  }

  dataFile <- googlesheets4::read_sheet(
    ss = fileId,
    skip = skipRows,
    na = missingValueCode)

  return(dataFile)

}