ISRaD.getdata: ISRaD.getdata

View source: R/ISRaD.getdata.R

ISRaD.getdataR Documentation

ISRaD.getdata

Description

Retrieves most recent version of ISRaD data from github

Usage

ISRaD.getdata(
  directory,
  dataset = "full",
  extra = FALSE,
  force_download = FALSE
)

Arguments

directory

Location of ISRaD_database_files folder. If not found, it will be created.

dataset

Specify which data you want. Options are c("full", flux","interstitial","incubation","fraction","layer")

extra

TRUE/FALSE. If TRUE, the ISRaD_extra object will be returned. If FALSE, ISRaD_data will be returned. Default is FALSE.

force_download

TRUE/FALSE. If ISRaD_database files already exist in the specified directory, new data will not be downloaded by default. If force_download is set to TRUE, the newest data from github will be downloaded and overwrite any existing files.

Value

ISRaD data object

Examples

# Return full dataset ("full")
ISRaD_full <- ISRaD.getdata(tempdir(), dataset = "full", extra = FALSE)
# Return full dataset plus "extra" filled data
ISRaD_extra <- ISRaD.getdata(tempdir(), dataset = "full", extra = TRUE)
# Return only fraction data, including filled fraction data
ISRaD_fractions <- ISRaD.getdata(tempdir(), dataset = "fraction", extra = TRUE)

ISRaD documentation built on Sept. 21, 2023, 9:06 a.m.

Related to ISRaD.getdata in ISRaD...