Subset and download a specific marine product from Copernicus
Source:R/cms_download_subset.r
cms_download_subset.Rd
Usage
cms_download_subset(
username = cms_get_username(),
password = cms_get_password(),
destination,
product,
layer,
variable,
region,
timerange,
verticalrange,
overwrite = FALSE,
progress = TRUE,
crop = TRUE,
asset,
...
)
Arguments
- username
Your Copernicus marine user name. Can be provided with
cms_get_username()
(default), or as argument here.- password
Your Copernicus marine password. Can be provided as
cms_get_password()
(default), or as argument here.- destination
This argument is deprecated. Data is no longer written to a file but loaded as a
stars::st_as_stars()
object into memory.- product
An identifier (type
character
) of the desired Copernicus marine product. Can be obtained withcms_products_list
.- layer
The name of a desired layer within a product (type
character
). Can be obtained withcms_product_details
.- variable
The name of a desired variable in a specific layer of a product (type
character
). Can be obtained withcms_product_details
.- region
Specification of the bounding box as a
vector
ofnumeric
s WGS84 lat and lon coordinates. Should be in the order of: xmin, ymin, xmax, ymax.- timerange
A
vector
with two elements (lower and upper value) for a requested time range. Thevector
should be coercible toPOSIXct
.- verticalrange
A
vector
with two elements (minimum and maximum) numerical values for the depth of the vertical layers (if any). Note that values below the sea surface needs to be specified as negative values.- overwrite
This argument is deprecated. Data is no longer written to a file but loaded as a
stars::st_as_stars()
object into memory.- progress
A logical value. When
TRUE
(default) progress is reported to the console. Otherwise, this function will silently proceed.- crop
On the server, the data is organised in chunks. The subset will download chunks that overlap with the specified ranges, but often covers a larger area. When
crop = TRUE
(default), the data will be cropped to the specifiedregion
. If set toFALSE
all downloaded data will be returned.- asset
Type of asset to be used when subsetting data. Should be one of
"default"
,"ARCO"
,"static"
,"omi"
, or"downsampled4"
. When missing, set toNULL
or set to"default"
, it will use the first asset available for the requested product and layer, in the order as listed before.- ...
Ignored (reserved for future features).
Value
Returns a stars::st_as_stars()
object.
Examples
if (interactive() && requireNamespace("blosc")) {
mydata <- cms_download_subset(
product = "GLOBAL_ANALYSISFORECAST_PHY_001_024",
layer = "cmems_mod_glo_phy-cur_anfc_0.083deg_P1D-m",
variable = c("uo", "vo"),
region = c(-1, 50, 10, 55),
timerange = c("2025-01-01 UTC", "2025-01-02 UTC"),
verticalrange = c(0, -2)
)
plot(mydata["vo"])
} else {
message("Make sure to run this in an interactive environment")
message("and that the package 'blosc' is installed")
}
#> Make sure to run this in an interactive environment
#> and that the package 'blosc' is installed