{"Package":"rnpn","Title":"Interface to the National 'Phenology' Network 'API'","Version":"1.3.0","Authors@R":"c(\nperson(\"Jeff\", \"Switzer\", , \"jeff@usanpn.org\", role = c(\"aut\", \"cre\")),\nperson(\"Scott\", \"Chamberlain\", role = \"aut\"),\nperson(\"Lee\", \"Marsh\", role = \"aut\"),\nperson(\"Kevin\", \"Wong\", role = \"aut\"),\nperson(\"Eric R\", \"Scott\", role = \"aut\", comment = c(ORCID = \"0000-0002-7430-7879\")),\nperson(\"David\", \"LeBauer\", role = \"ctb\")\n)","Description":"Programmatic interface to the Web Service methods provided by\nthe National 'Phenology' Network (), which\nincludes data on various life history events that occur at specific\ntimes.","License":"MIT + file LICENSE","URL":"https://github.com/usa-npn/rnpn, http://usa-npn.github.io/rnpn/","BugReports":"https://github.com/usa-npn/rnpn/issues","Depends":"R (>= 3.5.0)","Imports":"dplyr, httr2 (>= 1.1.0), magrittr, rlang, tibble, tidyr, xml2,\nyyjsonr","Suggests":"covr, ggplot2, knitr, markdown, RColorBrewer, rmarkdown, sf,\nterra, testthat (>= 3.0.0), vcr, withr","VignetteBuilder":"knitr","Config/testthat/edition":"3","Encoding":"UTF-8","RoxygenNote":"7.3.2","NeedsCompilation":"no","Packaged":"2025-03-05 18:43:33 UTC; jeff","Author":"Jeff Switzer [aut, cre],\nScott Chamberlain [aut],\nLee Marsh [aut],\nKevin Wong [aut],\nEric R Scott [aut] (),\nDavid LeBauer [ctb]","Maintainer":"Jeff Switzer ","Repository":"CRAN","Date/Publication":"2025-03-05 19:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/rnpn_1.3.0.tar.gz","jsonAuthors":[{"name":"Jeff Switzer","email":"jeff@usanpn.org","maintainer":true},{"name":"Scott Chamberlain","email":null,"maintainer":false},{"name":"Lee Marsh","email":null,"maintainer":false},{"name":"Kevin Wong","email":null,"maintainer":false},{"name":"Eric R Scott","email":null,"maintainer":false},{"name":"David LeBauer","email":null,"maintainer":false}],"readme":"\n# rnpn\n\n\n\n[![Project Status: Active – The project has reached a stable, usable\nstate and is being actively\ndeveloped.](http://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/)\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/rnpn)](https://CRAN.R-project.org/package=rnpn)\n[![R build\nstatus](https://github.com/usa-npn/rnpn//workflows/R-CMD-check/badge.svg)](https://github.com/usa-npn/rnpn/actions/workflows/R-CMD-check.yaml)\n[![Codecov test\ncoverage](https://codecov.io/gh/usa-npn/rnpn/graph/badge.svg)](https://app.codecov.io/gh/usa-npn/rnpn)\n\n\n`rnpn` is an R client for interacting with the USA National Phenology\nNetwork data web services. These services include access to a rich set\nof observer-contributed, point-based phenology records as well as\ngeospatial data products including gridded phenological model and\nclimatological data.\n\nDocumentation is available for the National Phenology Network [API\ndocumentation](https://docs.google.com/document/d/1yNjupricKOAXn6tY1sI7-EwkcfwdGUZ7lxYv7fcPjO8/edit?hl=en_US),\nwhich describes the full set of REST services this package wraps.\n\nThere is no need for an API key to grab data from the National Phenology\nNetwork but users are required to self identify, on an honor system,\nagainst requests that may draw upon larger datasets. For functions that\nrequire it, simply populate the request_source parameter with your name\nor the name of your institution.\n\n## Installation\n\nCRAN version\n\n``` r\ninstall.packages(\"rnpn\")\n```\n\nDevelopment version:\n\n``` r\ninstall.packages(\"devtools\")\nlibrary('devtools')\ndevtools::install_github(\"usa-npn/rnpn\")\n```\n\n``` r\nlibrary('rnpn')\n```\n\nThis package has dependencies on both curl and gdal. Some Linux based\nsystems may require additional system dependencies for those required\npackages, and accordingly this package, to install correctly. For\nexample, on Ubuntu:\n\n``` r\nsudo apt install libcurl4-openssl-dev\nsudo apt install libproj-dev libgdal-dev\n```\n\n## The Basics\n\nMany of the functions to search for data require knowing the internal\nunique identifiers of some of the database entities to filter the data\ndown efficiently. For example, if you want to search by species, then\nyou must know the internal identifier of the species. To get a list of\nall available species use the following:\n\n``` r\nspecies_list <- npn_species()\n```\n\nSimilarly, for phenophases:\n\n``` r\nphenophases <- npn_phenophases()\n```\n\n### Getting Observational Data\n\nThere are four main functions for accessing observational data, at\nvarious levels of aggregation. At the most basic level you can download\nthe raw status and intensity data.\n\n``` r\nsome_data <- npn_download_status_data(\n request_source = 'Your Name or Org Here',\n years = c(2015),\n species_id = c(35),\n states = c('AZ', 'IL')\n)\n```\n\nNote that through this API, data can only be filtered chronologically by\nfull calendar years. You can specify any number of years in each API\ncall. Also note that request_source is a required parameter and should\nbe populated with your name or the name of the organization you\nrepresent. All other parameters are optional but it is highly\nrecommended that you filter your data search further.\n\n### Getting Geospatial Data\n\nThis package wraps around standard WCS endpoints to facilitate the\ntransfer of raster data. Generally, this package does not focus on\ninteracting with WMS services, although they are available. To get a\nlist of all available data layers, use the following:\n\n``` r\nlayers <- npn_get_layer_details()\n```\n\nYou can then use the name of the layers to select and download\ngeospatial data as a raster.\n\n``` r\nnpn_download_geospatial(\n coverage_id = 'si-x:lilac_leaf_ncep_historic',\n date = '2016-12-31',\n format = 'geotiff',\n output_path = './six-test-raster.tiff'\n)\n```\n\n## Example of combined observational and geospatial data\n\nFor more details see Vignette VII\n\n

\n\n## What’s Next\n\nPlease read and review the vignettes for this package to get further\ninformation about the full scope of functionality available.\n\n## Acknowledgments\n\nThis code was developed, in part, as part of the integrated\n[Pheno-Synthesis Software Suite\n(PS3)](https://git.earthdata.nasa.gov/projects/APIS/repos/pheno-synthesis-software-suite/browse).\nThe authors acknowledge funding for this work through NASA’s AIST\nprogram (80NSSC17K0582, 80NSSC17K0435, 80NSSC17K0538, and\n80GSFC18T0003). The University of Arizona and the USA National Phenology\nNetwork’s efforts with this package are supported in part by US\nGeological Survey (G14AC00405, G18AC00135) and the US Fish and Wildlife\nService (F16AC01075 and F19AC00168).\n\n## Meta\n\n- Please [report any issues or\n bugs](https://github.com/usa-npn/rnpn/issues).\n- License: MIT\n- Get citation information for `rnpn` in R doing\n `citation(package = 'rnpn')`\n- Please note that this package is released with a [Contributor Code of\n Conduct](https://ropensci.org/code-of-conduct/). By contributing to\n this project, you agree to abide by its terms.","jobInfo":{"package":"rnpn","version":"1.3.0","parsingStatus":"success","parserVersion":2,"parsedAt":"2025-03-25T22:30:43+0000"}}

Description

Usage

Arguments