getTRMM: Download TRMM 3B42 Data

Description Usage Arguments Value Author(s) References See Also Examples

View source: R/getTRMM.R

Description

Download TRMM 3B42 version 7 daily (NetCDF) or 3-hourly (HDF) files for a given time span from the NASA FTP servers.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
getTRMM(
  begin,
  end,
  type = c("daily", "3-hourly"),
  dsn = ".",
  xml = FALSE,
  overwrite = FALSE,
  quiet = TRUE,
  cores = 1L,
  ...
)

Arguments

begin, end

Start and end date as Date or character.

type

character. Temporal resolution of downloaded TRMM data. Currently available options are "daily" (default) and "3-hourly".

dsn

character. Download folder, defaults to the current working directory.

xml

logical, defaults to FALSE. If TRUE, .xml files associated with each .nc4 file are also downloaded to 'dsn'.

overwrite

logical, defaults to FALSE. Determines whether existing files are overwritten.

quiet

logical. If TRUE (default), possible status messages and progress bar are suppressed, see download.file.

cores

integer. Number of cores for parallel processing. Note that this takes only effect if a sufficiently fast internet connection is available.

...

In case 'begin' and/or 'end' are character objects, additional arguments passed to as.Date.

Value

If xml = FALSE (default), a character vector of local file paths. Else a list of file paths with each entry corresponding to a single date.

Author(s)

Florian Detsch

References

MacRitchie K (2015) README Document for the Tropical Rainfall Measurement Mission (TRMM). Available online: https://disc2.gesdisc.eosdis.nasa.gov/data/TRMM_L3/TRMM_3B43/doc/README.TRMM_V7.pdf (2018-10-01).

See Also

download.file.

Examples

1
2
3
4
5
6
7
8
## Not run: 
## download TRMM 3B42 daily data from Jan 1 to Jan 5, 2015
getTRMM(begin = "2015-01-01", end = "2015-01-05")

## same for 3-hourly data
getTRMM(begin = "2015-01-01", end = "2015-01-05", type = "3-hourly")

## End(Not run)

environmentalinformatics-marburg/heavyRain documentation built on Sept. 1, 2020, 9:53 a.m.