diff --git a/R/CDownloadS.R b/R/CDownloadS.R index b94933f..7769530 100644 --- a/R/CDownloadS.R +++ b/R/CDownloadS.R @@ -1,6 +1,6 @@ #' Downloading Data from ECMWF Climate Data Store #' -#' This function is used to obtain data from the \href{Climate Data Store}{https://cds.climate.copernicus.eu/#!/home} hosted by the \href{Copernicus Climate Change Service (C3S)}{https://cds.climate.copernicus.eu/about-c3s}. By default, this function breaks down download calls into intervals so as to avoid submitting queries which fail, downloads queried data from \href{ECMWF}{https://www.ecmwf.int/} servers according to user-specification, and fuses the downloaded files together according to user-demands. The actual time to download is dependent on ECMWF download queues. Users need an \href{API key}{https://cds.climate.copernicus.eu/api-how-to} for download staging and accept terms and conditions for the specific queried dataset(s). +#' This function is used to obtain data from the \href{https://cds.climate.copernicus.eu/#!/home}{Climate Data Store (CDS)} hosted by the \href{https://cds.climate.copernicus.eu/about-c3s}{Copernicus Climate Change Service (C3S)}. By default, this function breaks down download calls into intervals so as to avoid submitting queries which fail, downloads queried data from \href{https://www.ecmwf.int/}{ECMWF} servers according to user-specification, and fuses the downloaded files together according to user-demands. The actual time to download is dependent on ECMWF download queues. Users need an \href{https://cds.climate.copernicus.eu/api-how-to}{API key} for download staging and accept terms and conditions for the specific queried dataset(s). #' #' @param Variable Character. Desired variable from queried dataset. See \code{\link{Meta.Variables}} for options per dataset. #' @param CumulVar Logical. Some ECMWF CDS data is recorded in cumulative steps per hour/month from the 00:00 time mark per day. Setting CumulVar to TRUE converts these into records which represent the total records per hour using the \code{\link{Temporal.Cumul}} function. Monthly cumulative records express the average daily total value. Setting this argument to TRUE multiplies monthly records by the number of days per the respective month(s) to get to total records instead of average. Default is FALSE. This argument can only be set to TRUE for cumulatively recorded variables. See \code{\link{Meta.Variables}} for an overview of which variables at recorded cumulatively per dataset. diff --git a/man/CDownloadS.Rd b/man/CDownloadS.Rd index 838bb44..72e457a 100644 --- a/man/CDownloadS.Rd +++ b/man/CDownloadS.Rd @@ -89,7 +89,7 @@ The SpatRaster contains metadata/attributes as a named vector that can be retrie \strong{ATTENTION:} If data is loaded again from disk at a later point with a different function, take note that the time zone will have to be set anew and existing time parameters in the .nc contents will need to be converted to the desired time zone. Likewise, citation and KrigR-call metadata will not be loaded properly from a .nc when loading data through a different function. CDownloads() handles these .nc specific issues when loading .nc files created previously with CDownloadS from disk. } \description{ -This function is used to obtain data from the \href{Climate Data Store}{https://cds.climate.copernicus.eu/#!/home} hosted by the \href{Copernicus Climate Change Service (C3S)}{https://cds.climate.copernicus.eu/about-c3s}. By default, this function breaks down download calls into intervals so as to avoid submitting queries which fail, downloads queried data from \href{ECMWF}{https://www.ecmwf.int/} servers according to user-specification, and fuses the downloaded files together according to user-demands. The actual time to download is dependent on ECMWF download queues. Users need an \href{API key}{https://cds.climate.copernicus.eu/api-how-to} for download staging and accept terms and conditions for the specific queried dataset(s). +This function is used to obtain data from the \href{https://cds.climate.copernicus.eu/#!/home}{Climate Data Store (CDS)} hosted by the \href{https://cds.climate.copernicus.eu/about-c3s}{Copernicus Climate Change Service (C3S)}. By default, this function breaks down download calls into intervals so as to avoid submitting queries which fail, downloads queried data from \href{https://www.ecmwf.int/}{ECMWF} servers according to user-specification, and fuses the downloaded files together according to user-demands. The actual time to download is dependent on ECMWF download queues. Users need an \href{https://cds.climate.copernicus.eu/api-how-to}{API key} for download staging and accept terms and conditions for the specific queried dataset(s). } \examples{ \dontrun{