https://github.com/doi-usgs/dataretrieval.jl
Julia port of the R and Python data retrieval packages
Science Score: 57.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
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
○Academic publication links
-
✓Committers with academic emails
1 of 1 committers (100.0%) from academic institutions -
✓Institutional organization owner
Organization doi-usgs has institutional domain (www.usgs.gov) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.8%) to scientific vocabulary
Keywords
Repository
Julia port of the R and Python data retrieval packages
Basic Info
- Host: GitHub
- Owner: DOI-USGS
- License: other
- Language: Julia
- Default Branch: main
- Homepage: https://doi-usgs.github.io/DataRetrieval.jl/
- Size: 736 KB
Statistics
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
DataRetrieval.jl
DataRetrieval.jl is a Julia alternative to the R dataRetrieval package for obtaining USGS water data directly from web services. There is also a Python dataretrieval package designed to perform the same functionality in the Python language.
Note: Due to the both the relative newness of the Julia language and a lack of knowledge regarding its adoption within the water community, the development of this package will be subject to demand from the community. Consequently, please raise an issue if there is functionality you'd like added to the Julia package.
Installation
The package currently must be installed from source. More stable, periodic, releases will be made to the 'main' branch while active development will occur on the 'dev' branch. To install the package, from the 'main' branch, run the following commands in the Julia REPL:
julia
julia> ]
pkg> add https://code.usgs.gov/water/computational-tools/DataRetrieval.jl.git
Usage
The package is designed to be used in a similar manner to the R package.
For example, to obtain information about a site, you can use the
readNWISsite function:
julia
julia> using DataRetrieval
julia> df, response = readNWISsite("05114000")
The readNWISsite function returns a DataFrame containing the site
information and a HTTP.Messages.Response object containing the raw API GET
query response. The DataFrame can be printed to the console:
julia
julia> df
1×12 DataFrame
Row │ agency_cd site_no station_nm site_tp_cd dec_lat_ ⋯
│ String7 String15 String31 String3 String15 ⋯
─────┼──────────────────────────────────────────────────────────────────────────
1 │ USGS 05114000 SOURIS RIVER NR SHERWOOD, ND ST 48.99001 ⋯
8 columns omitted
The HTTP.Messages.Response object can be used to examine the raw API GET
query response. For example, we can look at the status of the GET request; a
200 code, for example, indicates a successful response:
julia
julia> response.status
200
Documentation
The documentation for the package is currently available on RStudio Connect, and can be found here.
Documentation for the "dev" branch is also available, and can be found here.
Contributing
Contributions to the package are welcome. Please see the contributing guidelines for more information.
License
The package is licensed per the LICENSE.md file.
Acknowledgements
The package was developed by @jhariharan.
Disclaimer
See DISCLAIMER.md.
Contact
For questions or comments about the package, please contact J. Hariharan
Citing DataRetrieval.jl
When citing DataRetrieval.jl please use:
Hariharan, J.A., 2023, DataRetrieval.jl-Julia package for obtaining USGS water data directly from web services: U.S. Geological Survey software release, Julia package, Reston, Va., https://doi.org/10.5066/P95XLHUH.
Additional Publication Details
Additional metadata about this publication, not found in other parts of the page is in this table.
| Publication type | Julia language package |
|---|---|
| DOI | 10.5066/P95XLHUH |
| Year published | 2023 |
| Year of version | 2023 |
| Version | 0.1.0 |
| IPDS | IP-152366 |
Owner
- Name: U.S. Geological Survey
- Login: DOI-USGS
- Kind: organization
- Email: gs_help_git@usgs.gov
- Location: United States of America
- Website: https://www.usgs.gov/
- Twitter: USGS
- Repositories: 59
- Profile: https://github.com/DOI-USGS
By integrating our diverse scientific expertise, we understand complex natural science phenomena and provide scientific products that lead to solutions.
GitHub Events
Total
- Create event: 10
Last Year
- Create event: 10
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| elbeejay | j****n@u****v | 69 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v2 composite
- julia-actions/cache v1 composite
- julia-actions/julia-buildpkg v1 composite
- julia-actions/julia-runtest v1 composite
- julia-actions/setup-julia v1 composite
- JuliaRegistries/TagBot v1 composite
- JamesIves/github-pages-deploy-action v4.4.1 composite
- actions/checkout v2 composite
- julia-actions/setup-julia v1 composite