init_cmip6_index {epwshiftr} | R Documentation |
Build CMIP6 experiment output file index
Description
init_cmip6_index()
will search the CMIP6 model output file using esgf_query()
, return a data.table::data.table()
containing the actual NetCDF file url
to download, and store it into user data directory for future use.
Usage
init_cmip6_index(
activity = "ScenarioMIP",
variable = c("tas", "tasmax", "tasmin", "hurs", "hursmax", "hursmin", "pr", "rsds",
"rlds", "psl", "sfcWind", "clt"),
frequency = "day",
experiment = c("ssp126", "ssp245", "ssp370", "ssp585"),
source = c("AWI-CM-1-1-MR", "BCC-CSM2-MR", "CESM2", "CESM2-WACCM", "EC-Earth3",
"EC-Earth3-Veg", "GFDL-ESM4", "INM-CM4-8", "INM-CM5-0", "MPI-ESM1-2-HR",
"MRI-ESM2-0"),
variant = "r1i1p1f1",
replica = FALSE,
latest = TRUE,
resolution = c("100 km", "50 km"),
limit = 10000L,
data_node = NULL,
years = NULL,
save = FALSE
)
Arguments
activity |
A character vector indicating activity identifiers. Default:
|
variable |
A character vector indicating variable identifiers. The 12
most related variables for EPW are set as defaults. If
|
frequency |
A character vector of sampling frequency. If
|
experiment |
A character vector indicating root experiment identifiers.
The Tier-1 experiment of activity ScenarioMIP are set as defaults.
If |
source |
A character vector indicating model identifiers. Defaults are
set to 11 sources which give outputs of all 4 experiment of activity
ScenarioMIP with daily frequency, i.e. |
variant |
A character vector indicating label constructed from 4
indices stored as global attributes in format
|
replica |
Whether the record is the "master" copy, or a replica. Use
|
latest |
Whether the record is the latest available version, or a
previous version. Use |
resolution |
A character vector indicating approximate horizontal
resolution. Default: |
limit |
An integer indicating the maximum of matched records to return.
Should be <= 10,000. Default: |
data_node |
A character vector indicating data nodes to be queried.
Default to |
years |
An integer vector indicating the target years to be include in
the data file. All other years will be excluded. If |
save |
If |
Details
For details on where the file index is stored, see rappdirs::user_data_dir()
.
Value
A data.table::data.table with 22 columns:
No. | Column | Type | Description |
1 | file_id | Character | Model output file universal identifier |
2 | dataset_id | Character | Dataset universal identifier |
3 | mip_era | Character | Activity's associated CMIP cycle. Will always be "CMIP6" |
4 | activity_drs | Character | Activity DRS (Data Reference Syntax) |
5 | institution_id | Character | Institution identifier |
6 | source_id | Character | Model identifier |
7 | experiment_id | Character | Root experiment identifier |
8 | member_id | Character | A compound construction from sub_experiment_id and variant_label |
9 | table_id | Character | Table identifier |
10 | frequency | Character | Sampling frequency |
11 | grid_label | Character | Grid identifier |
12 | version | Character | Approximate date of model output file |
13 | nominal_resolution | Character | Approximate horizontal resolution |
14 | variable_id | Character | Variable identifier |
15 | variable_long_name | Character | Variable long name |
16 | variable_units | Character | Units of variable |
17 | datetime_start | POSIXct | Start date and time of simulation |
18 | datetime_end | POSIXct | End date and time of simulation |
19 | file_size | Character | Model output file size in Bytes |
20 | data_node | Character | Data node to download the model output file |
21 | dataset_pid | Character | A unique string that helps identify the dataset |
22 | tracking_id | Character | A unique string that helps identify the output file |
Note
Argument limit
will only apply to Dataset
query. init_cmip6_index()
will
try to get all model output files which match the dataset id.
Examples
## Not run:
init_cmip6_index()
## End(Not run)