cmip_download: Downloads CMIP data

View source: R/cmip-download.R

cmip_downloadR Documentation

Downloads CMIP data

Description

Downloads CMIP data

Usage

cmip_download(
  results,
  root = cmip_root_get(),
  user = Sys.info()[["user"]],
  comment = NULL,
  year_range = c(-Inf, Inf),
  check_diskspace = TRUE,
  download_config = cmip_download_config(),
  ...
)

cmip_download_config(
  delay = 0.5,
  retry = 5,
  total_connections = 1,
  host_connections = 1,
  low_speed_limit = 100,
  low_speed_time = 30
)

Arguments

results

A list of search results from cmip_search().

root

Root folder to download and organise the data.

user, comment

Deprecated.

year_range

An integer vector of length 2, indicating the start and end range of years. Restricts the download of model output with files that include some data within this range of years. Defaults to c(-Inf, Inf) to include all possible files

check_diskspace

Logical indicating whether to check if location has enough space to download all the requested files.

download_config

a list of arguments to configure the behaviour of downloads.

...

Ignored

delay

delay in seconds between retries. The actual delay adds a bit of randomness.

retry

number of retries before giving up on a download.

total_connections

maximum number of total concurrent connections.

host_connections

maximum number concurrent connections per host.

low_speed_limit, low_speed_time

the download will fail if it downloads at below low_speed_limit bytes/second for more than low_speed_time seconds.

Value

A list of files.


eliocamp/rcmip6 documentation built on Feb. 8, 2025, 4:26 p.m.