Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (18.1%) to scientific vocabulary
Last synced: 6 months ago
·
JSON representation
·
Repository
Basic Info
- Host: GitHub
- Owner: atsyplenkov
- License: other
- Language: R
- Default Branch: master
- Homepage: https://atsyplenkov.github.io/HBVr/
- Size: 5.96 MB
Statistics
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 2
Created over 3 years ago
· Last pushed about 3 years ago
Metadata Files
Readme
Changelog
License
Citation
README.Rmd
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# HBVr 
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/atsyplenkov/HBVr/actions/workflows/R-CMD-check.yaml)
[](https://github.com/atsyplenkov/HBVr/commits/master)
[](https://www.repostatus.org/#active)
[](https://codecov.io/gh/atsyplenkov/HBVr)
The goal of HBVr is to ease the accessebility of HBV Global Parameter maps created by Beck et al. ([2020](http://www.gloh2o.org/hbv/)). Therefore this one-function package allows to download any of the cross-validation folds for your particular area of interest (AOI).
## Installation
You can install the development version of HBVr from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("atsyplenkov/HBVr")
```
## Disclaimer
While `HBVr` does not redistribute the data or provide it in any way, we encourage users to cite original papers when using this package:
> Beck HE, Pan M, Lin P, Seibert J, van Dijk AIJM, Wood EF. 2020. Global Fully Distributed Parameter Regionalization Based on Observed Streamflow From 4,229 Headwater Catchments. Journal of Geophysical Research: Atmospheres 125 : e2019JD031485. DOI: 10.1029/2019JD03148
## Example
You can download mean zonal statistics
```{r message=FALSE, warning=FALSE}
library(HBVr)
# Locate the shapefile
f <- system.file("ex/lux.shp", package="terra")
# Read it as SpatVector
v <- vect(f)
zonal_stat <-
hbv_get_parameters(
aoi = v,
folds = 1,
mean = TRUE
)
zonal_stat
```
or retrieve a `SpatRaster` objects:
```{r}
rasters <-
hbv_get_parameters(
aoi = v,
folds = 1,
mean = FALSE
)
plot(rasters[[1]])
```
Owner
- Name: Anatolii Tsyplenkov
- Login: atsyplenkov
- Kind: user
- Location: New Zealand
- Company: @manaakiwhenua
- Website: anatolii.nz
- Repositories: 79
- Profile: https://github.com/atsyplenkov
Scientist-Geomorphologist and Research Software Engineer, fond of all things geospatial
Citation (CITATION.cff)
# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.2.2
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
cff-version: 1.2.0
message: 'To cite package "HBVr" in publications use:'
type: software
license: MIT
title: 'HBVr: Get HBV Parameters'
version: 0.0.2
abstract: This package offers a user-friendly approach to access the regionalized
HBV parameters maps created by Beck et al. (2020).
authors:
- family-names: Tsyplenkov
given-names: Anatoly
email: atsyplenkov@gmail.com
orcid: https://orcid.org/0000-0003-4144-8402
preferred-citation:
type: manual
title: 'HBVr: Get HBV Parameters'
authors:
- family-names: Tsyplenkov
given-names: Anatoly
email: atsyplenkov@gmail.com
orcid: https://orcid.org/0000-0003-4144-8402
version: 0.0.2
abstract: This package offers a user-friendly approach to access the regionalized
HBV parameters maps created by Beck et al. (2020).
repository-code: https://github.com/atsyplenkov/HBVr
url: https://atsyplenkov.github.io/HBVr/
contact:
- family-names: Tsyplenkov
given-names: Anatoly
email: atsyplenkov@gmail.com
orcid: https://orcid.org/0000-0003-4144-8402
license: MIT
year: '2022'
repository-code: https://github.com/atsyplenkov/HBVr
url: https://atsyplenkov.github.io/HBVr/
contact:
- family-names: Tsyplenkov
given-names: Anatoly
email: atsyplenkov@gmail.com
orcid: https://orcid.org/0000-0003-4144-8402
references:
- type: software
title: 'R: A Language and Environment for Statistical Computing'
notes: Depends
authors:
- name: R Core Team
location:
name: Vienna, Austria
year: '2022'
url: https://www.R-project.org/
institution:
name: R Foundation for Statistical Computing
version: '>= 3.5.0'
- type: software
title: terra
abstract: 'terra: Spatial Data Analysis'
notes: Depends
authors:
- family-names: Hijmans
given-names: Robert J.
email: r.hijmans@gmail.com
orcid: https://orcid.org/0000-0001-5872-2872
year: '2022'
url: https://CRAN.R-project.org/package=terra
version: '>= 1.5'
- type: software
title: knitr
abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
notes: Suggests
authors:
- family-names: Xie
given-names: Yihui
email: xie@yihui.name
orcid: https://orcid.org/0000-0003-0645-5666
year: '2022'
url: https://CRAN.R-project.org/package=knitr
- type: software
title: pbapply
abstract: 'pbapply: Adding Progress Bar to ''*apply'' Functions'
notes: Suggests
authors:
- family-names: Solymos
given-names: Peter
- family-names: Zawadzki
given-names: Zygmunt
year: '2022'
url: https://CRAN.R-project.org/package=pbapply
- type: software
title: rmarkdown
abstract: 'rmarkdown: Dynamic Documents for R'
notes: Suggests
authors:
- family-names: Allaire
given-names: JJ
email: jj@rstudio.com
- family-names: Xie
given-names: Yihui
email: xie@yihui.name
orcid: https://orcid.org/0000-0003-0645-5666
- family-names: McPherson
given-names: Jonathan
email: jonathan@rstudio.com
- family-names: Luraschi
given-names: Javier
email: javier@rstudio.com
- family-names: Ushey
given-names: Kevin
email: kevin@rstudio.com
- family-names: Atkins
given-names: Aron
email: aron@rstudio.com
- family-names: Wickham
given-names: Hadley
email: hadley@rstudio.com
- family-names: Cheng
given-names: Joe
email: joe@rstudio.com
- family-names: Chang
given-names: Winston
email: winston@rstudio.com
- family-names: Iannone
given-names: Richard
email: rich@rstudio.com
orcid: https://orcid.org/0000-0003-3925-190X
year: '2022'
url: https://CRAN.R-project.org/package=rmarkdown
- type: software
title: testthat
abstract: 'testthat: Unit Testing for R'
notes: Suggests
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@rstudio.com
year: '2022'
url: https://CRAN.R-project.org/package=testthat
version: '>= 3.0.0'
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Issues and Pull Requests
Last synced: 6 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
DESCRIPTION
cran
- R >= 3.5.0 depends
- terra >= 1.5 depends
- knitr * suggests
- pbapply * suggests
- rmarkdown * suggests
- testthat >= 3.0.0 suggests
.github/workflows/R-CMD-check.yaml
actions
- actions/checkout v2 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml
actions
- JamesIves/github-pages-deploy-action 4.1.4 composite
- actions/checkout v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite