datasetQuery: Query the query endpoint of the NEON API and create an arrow...

View source: R/datasetQuery.R

datasetQueryR Documentation

Query the query endpoint of the NEON API and create an arrow dataset from the results

Description

Uses the query endpoint of the NEON API to find the full list of files for a given data product, release, site(s), and date range, then turns them into an arrow dataset.

Usage

datasetQuery(
  dpID,
  site = "all",
  startdate = NA,
  enddate = NA,
  tabl = NA_character_,
  hor = NA,
  ver = NA,
  package = "basic",
  release = "current",
  include.provisional = FALSE,
  token = NA_character_
)

Arguments

dpID

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

site

Either the string 'all', meaning all available sites, or a character vector of 4-letter NEON site codes, e.g. c('ONAQ','RMNP'). Defaults to all.

startdate

Either NA, meaning all available dates, or a character vector in the form YYYY-MM, e.g. 2017-01. Defaults to NA.

enddate

Either NA, meaning all available dates, or a character vector in the form YYYY-MM, e.g. 2017-01. Defaults to NA.

tabl

The name of a single data table to download.

hor

The horizontal index of data to download. Only applicable to sensor (IS) data.

ver

The vertical index of data to download. Only applicable to sensor (IS) data.

package

Either 'basic' or 'expanded', indicating which data package to download. Defaults to basic.

release

The data release to be downloaded; either 'current' or the name of a release, e.g. 'RELEASE-2021'. 'current' returns the most recent release, as well as provisional data if include.provisional is set to TRUE. To download only provisional data, use release='PROVISIONAL'. Defaults to 'current'.

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.

token

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

Value

An arrow dataset for the data requested.

Author(s)

Claire Lunch clunch@battelleecology.org

References

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


neonUtilities documentation built on Aug. 8, 2025, 6:31 p.m.