gc_get_option: Get vector of available GlobColour products
In herrmannrobert/GlobColouR: R client for GlobColour products

Description Usage Arguments Details Examples

View source: R/Functions.R

Function examines available GlobColour products for a certain query and provides the respective file paths for direct FTP access via gc_get_colour.

1	gc_get_option(zone, sens, binp, date, type, fext, prle, reso)

`zone`	character indicating the requested region (mendatory). Use "GLOB" for global coverage or "EURO" for the european area (see Details).
`sens`	character indicating a satellite acronym (mendatory). Accepted values are "meris", "viirsn" ,"olcia", "modis", "seawifs", or "merged".
`binp`	character indicating the binning period (mendatory). Accepted values are "month", "8-day", or "day".
`date`	character defining the requested date (mendatory). Required format is "yyyy/mm/dd". Use "latest" for most current data (see Details).
`type`	character or vector of product types (optional). See Details for provided GlobColour products.
`fext`	character or vector of file extentions (optional). Provided data formats are "nc" (NetCDF4) and "png" (PortableNetworkGraphic).
`prle`	character or vector indicating the product level (optional). Accepted values are "L3m" (mapped grid) and "L3b" (ISIN grid).
`reso`	character or vector specifying the resolution (optional) to "1", "4", "25", and/or "100" km (see Details).

The first four arguments (zone, sens, binp, date) are mendatory, without which the function returns a table of accepted values to type in. The other arguments (type, fext, prle, reso) provide further filtering. For additional information see the GlobColour Product User's Guide.

The resolutions provided for the global coverage are 4, 25, and 100 km. The resolution for the europe-specific dataset is 1 km only. Values can optionally be set by reso.

If the requested date is after the most current date availabe the function automatically updates this attribute. The user can also type "latest" for automatically fetching the latest release.

The function shows all available types of data when using the mendatory arguments only. The provided data types (e.g. "KD490", "PAR", "CHL1") can then be used in type to accelerate the search process, and much more importantly, to shorten the list of files for download.

## Not run: 

#Provide user information
gc_set_user("ftp_gc_DDummy", "DDummy_1234")

#Accepted values to use for arguments (mendatory vs. optional)
gc_get_option()

#Latest available ocean optics (merged) on global coverage and daily intervals
gc_get_option(zone = "GLOB",
              sens = "merged",
              binp = "day",
              date = "latest")

#Further filtering options
gc_get_option(zone = "GLOB",
              sens = "merged",
              binp = "day",
              date = "latest",                          
              type = c("KD490", "PAR"),
              fext = c("nc"),
              reso = c(4, 25))

## End(Not run)