check_inventory: Perform some checks on the inventory

View source: R/check_inventory.R

check_inventoryR Documentation

Perform some checks on the inventory

Description

Some simple checks for multiple time frequencies, domains, ensembles, downscale realizations, and completeness of simulation periods. Can also run compare_variables_in_inventory to check for completeness of variables for all models. These checks are meant as guides only, since one might not wish multiple elements of the above for climate model ensemble assessments.

Usage

check_inventory(data_inventory, check_hist = FALSE, check_vars = FALSE)

Arguments

data_inventory

A data.table as resulting from get_inventory.

check_hist

Boolean, if TRUE, tests that each rcp* has a corresponding historical run.

check_vars

Boolean, if TRUE, runs compare_variables_in_inventory to check if all variables are available in all models.

Details

The checks are

  • for multiple time frequency (day, month, ...)

  • for multiple domains (EUR-11, EUR-44, ...)

  • for multiple ensembles (r1i1p1, r2i1p1, ...)

  • for multiple downscale realizations (v1, v2, ..)

  • for complete periods of simulations: historical usually goes approx. from 1950/70 - 2005, and rcp* from 2006 - 2100; evaluation is not checked, because it has very heterogeneous periods; cordex-adjust has historical and rcp* combined

  • that each rcp* has a corresponding historical run (optional, off by default; otherwise problematic with merged hist and rcp runs, as in cordex-adjust)

  • that all variables (tas, pr, ...) are available for all models (optional, off by default)

Value

An object of class "eurocordexr_inv_check" (an overloaded list) with results from the checks. Has a special print method, which shows a verbose summary of the results.

Examples

# some empty example files
fn_zip <- system.file("extdata", "inv-test-files.zip", package = "eurocordexr")
tmpdir <- tempdir()
unzip(fn_zip, exdir = tmpdir)

dat_inv <- get_inventory(fs::path(tmpdir, "testdata"))
check_inventory(dat_inv)


eurocordexr documentation built on Aug. 24, 2023, 9:07 a.m.