Make.Request: Form CDS Requests

View source: R/CDSAPI.R

Make.RequestR Documentation

Form CDS Requests

Description

Loops over time windows of defined size and creates a list of CDS requests.

Usage

Make.Request(
  QueryTimeWindows,
  QueryDataSet,
  QueryType,
  QueryVariable,
  QueryTimes,
  QueryExtent,
  QueryFormat,
  Dir = getwd(),
  verbose = TRUE,
  API_User,
  API_Key,
  TimeOut = 36000,
  FIterStart = 1
)

Arguments

QueryTimeWindows

List. List of date ranges created by Make.RequestWindows.

QueryDataSet

Character. Dataset specified by user.

QueryType

Character. Dataset type specified by user.

QueryVariable

Character. CDS internal variable name.

QueryTimes

Character. Layers of data in the raw data set

QueryExtent

Character. Extent object created by Check.Ext(Extent)[c(4,1,3,2)]

QueryFormat

Character. File format queried by user

Dir

Directory pointer. Where to store CDS request outcomes.

verbose

Logical. Whether to print/message function progress in console or not.

API_User

Character. CDS API User

API_Key

Character. CDS API Key

TimeOut

Numeric. Legacy, ignored when querying data from new CDS (https://cds-beta.climate.copernicus.eu/; this happens when the package version of ecmwfr is >= 2.0.0). The timeout for each download in seconds. Default 36000 seconds (10 hours).

FIterStart

Numeric. Meant for consistent file numbering in multi-chunk requesting.

Value

List. Each element holding either (1) a list object representing a CDS request or (2) the value NA indicating that a file of this name is already present.

See Also

Make.RequestWindows, Register.Credentials, Execute.Requests.

Make list of CDS Requests


ErikKusch/KrigR documentation built on Feb. 17, 2025, 2:09 p.m.