R/gs4_find.R

In googlesheets4: Access Google Sheets using the Sheets API V4

#' Find Google Sheets
#'
#' Finds your Google Sheets. This is a very thin wrapper around
#' [googledrive::drive_find()], that specifies you want to list Drive files
#' where `type = "spreadsheet"`. Therefore, note that this will require auth for
#' googledrive! See the article [Using googlesheets4 with
#' googledrive](https://googlesheets4.tidyverse.org/articles/articles/drive-and-sheets.html)
#' if you want to coordinate auth between googlesheets4 and googledrive. This
#' function will emit an informational message if you are currently logged in
#' with both googlesheets4 and googledrive, but as different users.
#'
#' @param ... Arguments (other than `type`, which is hard-wired as `type =
#'   "spreadsheet"`) that are passed along to [googledrive::drive_find()].
#'
#' @inherit googledrive::drive_find return
#' @export
#'
#' @examplesIf gs4_has_token()
#' # see all your Sheets
#' gs4_find()
#'
#' # see 5 Sheets, prioritized by creation time
#' x <- gs4_find(order_by = "createdTime desc", n_max = 5)
#' x
#'
#' # hoist the creation date, using other packages in the tidyverse
#' # x %>%
#' #   tidyr::hoist(drive_resource, created_on = "createdTime") %>%
#' #   dplyr::mutate(created_on = as.Date(created_on))
gs4_find <- function(...) {
  check_gs4_email_is_drive_email()
  googledrive::drive_find(..., type = "spreadsheet")
}