wf_archetype: Creates an archetype function

In khufkens/ecmwfr: Interface to 'ECMWF' and 'CDS' Data Web Services

Creates an archetype function

Description

Creates a universal MARS / CDS formatting function, in ways similar to wf_modify_request() but the added advantage that you could code for the use of dynamic changes in the parameters provided to the resulting custom function.

Usage

wf_archetype(request, dynamic_fields)

Arguments

request	a MARS or CDS request as an R list object.
dynamic_fields	character vector of fields that could be changed.

Details

Contrary to a simple replacement as in wf_modify_request() the generated functions are considered custom user written. Given the potential for complex formulations and formatting commands NO SUPPORT for the resulting functions can be provided. Only the generation of a valid function will be guaranteed and tested for.

Value

a function that takes 'dynamic_fields' as arguments and returns a request as an R list object.

Examples

## Not run: 

ERA <- wf_archetype(
  request = list(
    dataset_short_name = "reanalysis-era5-pressure-levels",
    product_type = "reanalysis",
    variable = "geopotential",
    year = "2024",
    month = "03",
    day = "01",
    time = "13:00",
    pressure_level = "1000",
    data_format = "grib",
    target = "download.grib"
  ),
    dynamic_fields = c("year", "day", "target")
  )
# print output of the function with below (new) parameters
str(ERA(2021, 3, "new_download.grip"))


## End(Not run)

khufkens/ecmwfr documentation built on Nov. 21, 2024, 5:19 a.m.