set_gbif_credentials: Store GBIF credentials

Description

This function sets GBIF credentials (username, email and password) as environment variables in the R environment. These credentials are required to retrieve occurrence records from GBIF.

Usage

set_gbif_credentials(
  gbif_username,
  gbif_email,
  gbif_password,
  permanently = FALSE,
  overwrite = FALSE,
  open_Renviron = FALSE,
  verbose = TRUE
)

Value

If permanently and open_Renviron are set to TRUE, it opens the .Renviron file. Otherwise, the credentials are saved silently.

Arguments

gbif_username: (character) your GBIF username.
gbif_email: (character) your GBIF email address.
gbif_password: (character) your GBIF password.
permanently: (logical) whether to add the GBIF credentials permanently to the R environment. Default is FALSE, meaning it will be added only temporarily for the current session.
overwrite: (logical) whether to overwrite GBIF credentials if they already exist. Only applicable if permanently is set to TRUE. Default is FALSE.
open_Renviron: (logical) whether to open the .Renviron file after saving the credentials. Only applicable if permanently is set to TRUE. Default is FALSE.
verbose: (logical) if TRUE, prints messages about the progress and the number of species being checked. Default is TRUE.

Examples

Run this code

if (FALSE) {
set_gbif_credentials(gbif_username = "my_username",
                     gbif_email = "my_email@example.com",
                     gbif_password = "my_password")
}

Run the code above in your browser using DataLab