spod_available_data_v2 {spanishoddata} | R Documentation |
Get the data dictionary
Description
This function retrieves the data dictionary for the specified data directory.
Usage
spod_available_data_v2(
data_dir = spod_get_data_dir(),
check_local_files = FALSE,
use_s3 = TRUE,
force = FALSE,
quiet = FALSE
)
Arguments
Value
A tibble with links, release dates of files in the data, dates of data coverage, local paths to files, and the download status.
- target_url
character
. The URL link to the data file.- pub_ts
POSIXct
. The timestamp of when the file was published.- file_extension
character
. The file extension of the data file (e.g., 'tar', 'gz').- data_ym
Date
. The year and month of the data coverage, if available.- data_ymd
Date
. The specific date of the data coverage, if available.- study
factor
. Study category derived from the URL (e.g., 'basic', 'complete', 'routes').- type
factor
. Data type category derived from the URL (e.g., 'number_of_trips', 'origin-destination', 'overnight_stays', 'data_quality', 'metadata').- period
factor
. Temporal granularity category derived from the URL (e.g., 'day', 'month').- zones
factor
. Geographic zone classification derived from the URL (e.g., 'districts', 'municipalities', 'large_urban_areas').- local_path
character
. The local file path where the data is (or going to be) stored.- downloaded
logical
. Indicator of whether the data file has been downloaded locally. This is only available ifcheck_local_files
isTRUE
.