R/googledrive-package.R

#' @description googledrive allows you to interact with files on Google Drive
#'   from R.
#'
#'   `googledrive::drive_find(n_max = 50)` lists up to 50 of the files you see
#'   in [My Drive](https://drive.google.com). You can expect to be sent to your
#'   browser here, to authenticate yourself and authorize the googledrive
#'   package to deal on your behalf with Google Drive.
#'
#'   Most functions begin with the prefix `drive_`.
#'
#'   The goal is to allow Drive access that feels similar to Unix file system
#'   utilities, e.g., `find`, `ls`, `mv`, `cp`, `mkdir`, and `rm`.
#'
#'   The metadata for one or more Drive files is held in a [`dribble`], a "Drive
#'   tibble". This is a data frame with one row per file. A dribble is returned
#'   (and accepted) by almost every function in googledrive. It is designed to
#'   give people what they want (file name), track what the API wants (file id),
#'   and to hold the metadata needed for general file operations.
#'
#'   googledrive is "pipe-friendly" and, in fact, re-exports `%>%`, but does not
#'   require its use.
#'
#'   Please see the googledrive website for full documentation:

#'   * <https://googledrive.tidyverse.org/index.html>

#'
#' In addition to function-specific help, there are several articles which are
#' indexed here:

#' * [Article index](https://googledrive.tidyverse.org/articles/index.html)

#'
#' @keywords internal
#' @import rlang
#' @import vctrs
"_PACKAGE"

## usethis namespace: start
#' @importFrom gargle bulletize
#' @importFrom gargle gargle_map_cli
#' @importFrom glue glue
#' @importFrom glue glue_collapse
#' @importFrom glue glue_data
#' @importFrom lifecycle deprecated
#' @importFrom pillar pillar_shaft
#' @importFrom purrr map
#' @importFrom purrr map_chr
#' @importFrom purrr map_if
#' @importFrom purrr map_int
#' @importFrom purrr map_lgl
#' @importFrom purrr map2
#' @importFrom purrr pluck
#' @importFrom tibble as_tibble
#' @importFrom tibble tbl_sum
#' @importFrom tibble tibble
## usethis namespace: end
NULL

#' googledrive configuration
#'
#' @description
#' Some aspects of googledrive behaviour can be controlled via an option.
#'
#' @section Auth:
#'
#' Read about googledrive's main auth function, [drive_auth()]. It is powered
#' by the gargle package, which consults several options:
#' * Default Google user or, more precisely, `email`: see
#'   [gargle::gargle_oauth_email()]
#' * Whether or where to cache OAuth tokens: see
#'   [gargle::gargle_oauth_cache()]
#' * Whether to prefer "out-of-band" auth: see
#'   [gargle::gargle_oob_default()]
#' * Application Default Credentials: see [gargle::credentials_app_default()]
#'
#' @name googledrive-configuration
NULL
tidyverse/googledrive documentation built on Jan. 14, 2024, 3:44 a.m.