neonUtilities (version 2.4.3)

byFileAOP: Serially download all AOP files for a given site, year, and product

Description

Query the API for AOP data by site, year, and product, and download all files found, preserving original folder structure. Downloads serially to avoid overload; may take a very long time.

Usage

byFileAOP(
  dpID,
  site,
  year,
  include.provisional = FALSE,
  check.size = TRUE,
  savepath = NA,
  token = NA_character_
)

Value

A folder in the working directory, containing all files meeting query criteria.

Arguments

dpID

The identifier of the NEON data product to pull, in the form DPL.PRNUM.REV, e.g. DP1.10023.001

site

The four-letter code of a single NEON site, e.g. 'CLBJ'.

year

The four-digit year to search for data. Defaults to 2017.

include.provisional

T or F, should provisional data be included in downloaded files? Defaults to F. See https://www.neonscience.org/data-samples/data-management/data-revisions-releases for details on the difference between provisional and released data.

check.size

T or F, should the user approve the total file size before downloading? Defaults to T. When working in batch mode, or other non-interactive workflow, use check.size=F.

savepath

The file path to download to. Defaults to NA, in which case the working directory is used.

token

User specific API token (generated within data.neonscience user accounts)

Author

Claire Lunch Christine Laney

References

License: GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007

Examples

if (FALSE) {
# To download 2017 vegetation index data from San Joaquin Experimental Range:
byFileAOP(dpID="DP3.30026.001", site="SJER", year="2017")
}