gt_get_data {geysertimes}

Download GeyserTimes Data

Description

Downloads the data from geysertimes.org. Reads the data and creates a tibble object in 'dest_folder'.

Usage

gt_get_data(dest_folder = file.path(tempdir(), "geysertimes"),
  overwrite = FALSE, quiet = FALSE, version = lubridate::today())

Arguments

dest_folder

the location where the binary tibble object should be written. The default is under the current R session's temp directory which will disappear when the session ends.

overwrite

a logical value, ifFALSE, the data will not be downloaded again if copy of the data, with version, already exists in dest_folder.

quiet

a logical value, if TRUE, no messages are displayed.

version

a character string giving the version of the data to download. This should a date in the form yyyy-mm-dd. Typically, only the version with today's date is available.

Details

The data is downloaded from the GeyserTimes archive web site https://geysertimes.org/archive/ to the tempdir() directory. The data is then read with readr::read_tsv with appropriate column types. The resulting tibble object is then saved as an binary (.rds) in dest_folder.

Value

a character string giving the full path to the directory where the GeyserTimes data was stored.

Note

Users are encouraged to set dest_folder to gt_path() to save a persistent copy of the data.

Author(s)

Stephen Kaluzny <[e-mail]>.

See Also

gt_load_eruptions, gt_load_geysers.

Examples

dpath0 <- gt_get_data()  # data saved under tempdir()
dpath1 <- gt_get_data(dest=gt_path())  # data saved under gt_path()
gt_cleanup_data(gt_version())