cl_DownloadData: Download files from pangaea :...

Description Usage Arguments Value Examples

View source: R/cl_DownloadData.R

otherwise from

1
http://obs-vlfr.fr/Pfunction/

Description

Download files used by cl_GetData() function.

Usage

1
2
3
4
5
6
7
cl_DownloadData(
  month = 0,
  DownloadGeo = TRUE,
  dirdata = "CoastalLight.d",
  alt = 0,
  stat = "mean"
)

Arguments

month

: [integer] decimal month (0-12). Default = 0.

  • 0 indicates the climatology over 21 years (1998-2018).

  • 1 to 12 indicates the decimal value for a single month (1 = January, ...);

DownloadGeo

: [logical] download the "geographic" file containing longitude, latitude, depth and surface area of the pixels, mandatory for retrieving pixel locations (default = TRUE)

dirdata

: [character] The directory where the files are stored (default = "./CoastalLight.d");

alt

: [integer] the way of downloading (0, 1 or 2). Default = 0

  • 0 automatically connect to Pangaea database and download

  • 1 launch your default browser and connect for manual download to URL

            http://obs-vlfr.fr/Pfunction/
                          
  • 2 launch your default browser and connect for manual download to URL

            https://doi.pangaea.de/10.1594/PANGAEA.910898
                          

N.B. : if you choose a manual download (alt = 1 or 2), you have to download files in the appropriate directory, i.e. the argument dirdata has no effect.

stat

: [character] the statistical value you want for variables "par", "kdpar" and "parbottom"; choose one among "mean" (mean value), "min" (minimum), "max" (maximum), "sd" (standard deviation) (default = "mean") N.B. : "min", "max", "sd", are available only at URL

        http://obs-vlfr.fr/Pfunction/
                      

Value

: none

Examples

1
2
3
4
5
cl_DownloadData() # annual climatology over 21 years (1998-2018)
cl_DownloadData(month = 1) # monthly climatology (January) over 21 years (1998-2018)
cl_DownloadData(month = 8) # monthly climatology (August) over 21 years (1998-2018)
cl_DownloadData(month = 8, stat = "sd") # idem, 
but download standard deviation of optical parameters

jpgattuso/CoastalLight documentation built on June 25, 2021, 5:34 p.m.