search

nwfsc-cb / rCAX

rCAX R package: an R client to access the REST API for the StreamNet Coordinated Assessments tables
https://nwfsc-cb.github.io/rCAX/
Other
5 stars 1 forks source link
noaa r-package rest-api salmon

readme

github check-release

rCAX

rCAX is an R client for the Coordinated Assessments API. Coordinated Assessments data eXchange (CAX) is developed by the Coordinated Assessments Partnership (CAP). CAP is a collaborative process to efficiently share and provide access to standardized derived information, such as fish population-scale high-level indicators (HLIs) and supporting metrics. Participants in CAP include state fish and wildlife management agencies, tribes, federal agencies such as National Oceanic and Atmospheric Administration Fisheries (NOAA Fisheries) and Bonneville Power Administration (BPA), and others. CAP is co-sponsored by StreamNet and Pacific Northwest Aquatic Monitoring Partnership (PNAMP). Make sure to review the StreamNet Terms of Use for these data, the StreamNet Data Policy and the citation information from StreamNet and PNAMP for database queries. rCAX authors: Eli Holmes and Mari Williams, Northwest Fisheries Science Center, NOAA Fisheries.

Installation

Install the latest GitHub release. You only need to do this once.

install.packages("remotes") # needed for the next line
remotes:::install_github("nwfsc-cb/rCAX@*release")

Download a table

Read about the CAX data and terms. Then read the Basic functions vignette to get started and see examples of how to make queries.

To retrieve the NOSA data for NMFS_popid 7 that is the same as the file that one can download from CAP Fish HLIs Tabular Query, use

library(rCAX)
f <- list(nmfs_popid=7)
tab <- rcax_hli("NOSA", flist = f)

Check the versions

You can check your installed version versus that on GitHub at any time using rcax_version().

Contributing

Fork and put in a pull request! The documentation is provided via a pkgdown site. After changing files run pkgdown::build_site().

Contributors

Contributors

Credits

Thanks to the developers of rredlist package who created a package that was easy to use as a template for a REST API client with R. Some of the base functions in rCAX are directly derived from the rredlist packages (and this is noted in the function references).

Disclaimer

This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project content is provided on an "as is" basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.

License

This content was created by U.S. Government employees as part of their official duties. This content is not subject to copyright in the United States (17 U.S.C. §105) and is in the public domain within the United States of America. The rCAX package as a whole is distributed under GNU GENERAL PUBLIC LICENSE version 3 (GPL-3).