rcax
rCAX R package: an R client to access the REST API for the StreamNet Coordinated Assessments tables
Science Score: 46.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
✓DOI references
Found 4 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.7%) to scientific vocabulary
Keywords
Repository
rCAX R package: an R client to access the REST API for the StreamNet Coordinated Assessments tables
Basic Info
- Host: GitHub
- Owner: nwfsc-cb
- License: apache-2.0
- Language: R
- Default Branch: main
- Homepage: https://nwfsc-cb.github.io/rCAX/
- Size: 1.9 MB
Statistics
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 9
- Releases: 11
Topics
Metadata Files
README.md
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.
r
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(lazy=FALSE).
Contributors
Citation
Holmes EE, Williams M (2023). “rCAX: Coordinated Assessments REST API R Client. R package version 1.0.3.” NOAA Fisheries, Northwest Fisheries Science Center, Math Bio Program. doi:10.5281/zenodo.7402463.
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 the Apache 2.0 license.
Owner
- Name: nwfsc-cb
- Login: nwfsc-cb
- Kind: organization
- Repositories: 10
- Profile: https://github.com/nwfsc-cb
GitHub Events
Total
- Issues event: 3
- Watch event: 1
- Push event: 9
- Fork event: 1
Last Year
- Issues event: 3
- Watch event: 1
- Push event: 9
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Eli Holmes | e****s@n****v | 115 |
| Mari Williams | 6****s | 6 |
| katiebarnas | 1****s | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 33
- Total pull requests: 8
- Average time to close issues: 7 days
- Average time to close pull requests: about 4 hours
- Total issue authors: 2
- Total pull request authors: 2
- Average comments per issue: 1.97
- Average comments per pull request: 0.0
- Merged pull requests: 8
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 3
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- eeholmes (25)
- mari-williams (8)
Pull Request Authors
- eeholmes (5)
- mari-williams (3)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
- Total downloads: unknown
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 22
proxy.golang.org: github.com/nwfsc-cb/rCAX
- Documentation: https://pkg.go.dev/github.com/nwfsc-cb/rCAX#section-documentation
- License: apache-2.0
-
Latest release: v1.0.3
published about 2 years ago
Rankings
proxy.golang.org: github.com/nwfsc-cb/rcax
- Documentation: https://pkg.go.dev/github.com/nwfsc-cb/rcax#section-documentation
- License: apache-2.0
-
Latest release: v1.0.3
published about 2 years ago
Rankings
Dependencies
- crul >= 0.3.8 imports
- jsonlite >= 1.1 imports
- knitr * suggests
- rmarkdown * suggests
- actions/checkout v3 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite