{"id":19568016,"url":"https://github.com/rchlumsk/ravenr","last_synced_at":"2025-04-05T05:04:59.280Z","repository":{"id":24466255,"uuid":"101680453","full_name":"rchlumsk/RavenR","owner":"rchlumsk","description":"R package for handling Raven hydrologic modelling framework inputs, outputs, and diagnostics","archived":false,"fork":false,"pushed_at":"2024-11-08T05:46:06.000Z","size":36332,"stargazers_count":36,"open_issues_count":12,"forks_count":16,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-29T04:05:46.115Z","etag":null,"topics":["diagnostics","hydrology","modeling","modelling","r","visualization","water","water-resources","watershed"],"latest_commit_sha":null,"homepage":null,"language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rchlumsk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-28T19:34:24.000Z","updated_at":"2024-11-08T05:46:12.000Z","dependencies_parsed_at":"2023-01-14T13:30:37.789Z","dependency_job_id":"abaab41f-de37-48a7-a71e-36b2b066abb9","html_url":"https://github.com/rchlumsk/RavenR","commit_stats":{"total_commits":128,"total_committers":12,"mean_commits":"10.666666666666666","dds":0.203125,"last_synced_commit":"7ebacb8e69acd7aa98256d57baad512ba54c844b"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rchlumsk%2FRavenR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rchlumsk%2FRavenR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rchlumsk%2FRavenR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rchlumsk%2FRavenR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rchlumsk","download_url":"https://codeload.github.com/rchlumsk/RavenR/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289426,"owners_count":20914464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diagnostics","hydrology","modeling","modelling","r","visualization","water","water-resources","watershed"],"created_at":"2024-11-11T05:43:16.006Z","updated_at":"2025-04-05T05:04:59.261Z","avatar_url":"https://github.com/rchlumsk.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"README\n================\n\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/RavenR)](https://cran.r-project.org/package=RavenR)\n[![downloads](https://cranlogs.r-pkg.org:443/badges/grand-total/RavenR?color=yellowgreen)](https://cranlogs.r-pkg.org:443/badges/grand-total/RavenR?color=yellowgreen)\n![lifecycle](./man/figures/lifecycle-experimental.svg)\n[![license](https://img.shields.io/badge/license-GPL3-lightgrey.svg)](https://choosealicense.com/)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4248183.svg)](https://doi.org/10.5281/zenodo.4248183)\n\n# RavenR \u003cimg src=\"inst/extdata/logo/RavenR_logo_small.png\" align=\"right\" /\u003e\n\n`RavenR` is an R package for handling [Raven](https://raven.uwaterloo.ca/) hydrologic modelling framework\ninputs, outputs, and diagnostics. \n\n## Installation\n\nThe CRAN version of the package may also installed with:\n``` r\ninstall.packages(\"RavenR\")\n```\n\nYou can also install the latest `RavenR` version from github with:\n\n``` r\nif (!require(devtools)) install.packages(\"devtools\")\nlibrary(devtools)\ndevtools::install_github(\"rchlumsk/RavenR\")\n```\n\nThe developmental version can be installed from the `dev` branch with:\n\n``` r\nif (!require(devtools)) install.packages(\"devtools\")\nlibrary(devtools)\ndevtools::install_github(\"rchlumsk/RavenR\", ref=\"dev\")\n```\n\n## Tutorials and Quick Start Guide\n\nPlease see the package vignette for an overview of the `RavenR` package. \nSample data is included in the package, so you need only\nto install the `RavenR` library and follow along in the guide documents to\nget started.\n\nThe `RavenR` vignette can be accessed with the `browseVignettes` function.\n``` r\nbrowseVignettes(\"RavenR\")\n```\n\n## Citation (Publication)\nTo cite `RavenR` in publications, please use the publication reference below.\n\n\u003e Chlumsky, R., Craig, J. R., Lin, S. G. M., Grass, S., Scantlebury, L., Brown, G., and Arabzadeh, R.: RavenR v2.1.4: an open-source R package to support flexible hydrologic modelling, Geosci. Model Dev., 15, 7017–7030, https://doi.org/10.5194/gmd-15-7017-2022, 2022.\n  \nA BibTeX entry for LaTeX users is:\n\n\u003e  @Article{gmd-15-7017-2022,  \n\u003e      title = {\\texttt{RavenR} v2.1.4: an open-source R package to support flexible hydrologic modelling},  \n\u003e      author = {Chlumsky, R. and Craig, J. R. and Lin, S. G. M. and Grass, S. and Scantlebury, L. and Brown, G. and Arabzadeh, R.},  \n\u003e      journal = {Geoscientific Model Development},  \n\u003e      volume = {15},  \n\u003e      year = {2022},  \n\u003e      number = {18},  \n\u003e      pages = {7017--7030},  \n\u003e      url = {https://gmd.copernicus.org/articles/15/7017/2022/},  \n\u003e      doi = {10.5194/gmd-15-7017-2022}  \n\u003e  }  \n\n## Citation (Software)\n```{r}\ncitation(\"RavenR\")\n```\n\nThe `RavenR` software itself can also be cited in publications, use:\n\n\u003e Robert Chlumsky, James Craig, Leland Scantlebury, Simon\n  Lin, Sarah Grass, Genevieve Brown and Rezgar Arabzadeh\n  (2022). RavenR: Raven Hydrological Modelling Framework R Support and Analysis. R\n  package version 2.1.9. https://github.com/rchlumsk/RavenR\n  \nA BibTeX entry for LaTeX users is:\n\n\u003e  @Manual{RavenRPackage,  \n\u003e      title = {RavenR: Raven Hydrological Modelling Framework R Support and Analysis},  \n\u003e      author = {Robert Chlumsky and James Craig and Leland Scantlebury and Simon Lin and Sarah Grass and Genevieve Brown and Rezgar Arabzadeh},  \n\u003e      year = {2022},  \n\u003e      note = {R package version 2.1.9},  \n\u003e      url = {https://github.com/rchlumsk/RavenR},  \n\u003e      doi = {10.5281/zenodo.3468441}\n\u003e  }\n\n\n## RavenR Wishlist\n\nAny issues or feature requests can be submitted on the [Github Issues page](https://github.com/rchlumsk/RavenR/issues) as an issue, or \ndiscussed more openly on the new [Github Discussions page](https://github.com/rchlumsk/RavenR/discussions).\n\n## Version Update Notes\n\n### 2.2.1\n\nMinor updates and new functionality, including:\n\n  - new function for generic reading of output csv files, `rvn_csv_read`;\n  - new function for writing Ostrich calibration templates, `rvn_rvp_calib_template`;\n  - new function for updating commands in the rvi file, `rvn_rvi_commandupdate`;\n  - update of all http urls to https;\n  - update in rvn_rvt_met_write to move the :RedirectToFile within the gauge block; and\n  - update to master database files for new connections and infilling some parameter ranges;\n\n### 2.2.0\n\nMinor updates and new functionality, including:\n\n  - update to blankHRUdf and blankSBdf functions to make them slightly more intelligent;\n  - update to master database files for HYPR model parameters and connections;\n  - updated package vignette minor deficiency where rvp_out was not writing to a temporary file; and \n  - minor fixes to `rvn_rvh_query`, `rvn_met_recordplot` documentation.\n\n### 2.1.8\n\nMinor updates and new functionality, including:\n\n  - added new functions including `rvn_rvh_query` and `rvn_rvh_summarize` for working with RVH files;\n  - updated package vignette with sections on building a basic model files and a model workflow for RVI/RVP files, and a third exercise; and \n  - fix to `rvn_monthly_vbias` to exclude months with missing days;\n\n\n### 2.1.7\n\nMinor updates and bug fixes, including:\n\n  - added new functions including `rvn_rvp_fill_template` for filling in rvp template files, `rvn_met_recordplot` to show station record lengths; \n  - added function for plotting subbasin network with interactive `visNetwork` library\n  - updated `rvn_run` with additional options, including adding rvi commands to the file before execution;   \n  - added new model templates from Raven Manual v3.5 to `rvn_rvi_write_template`; \n  - enhancements to `rvn_rvh_read` for splitting subbasin and HRU information in separate files, other minor improvements; and\n  - bug fix in `rvn_rvt_write` for writing initial start date with correct month code;\n\n\n### 2.1.4\n\nUpdates to a number of functions and new features implemented, including:\n\n  - removal of all dependencies on spatial packages (e.g. sf, raster),\n    and removal of the netcdf-related functions; \n  - `rvn_download` and `rvn_run` to enable downloading and running Raven.exe within R;    \n  - `rvn_rvi_write_template` to write model rvi files from templates in the Raven manual;\n  - `rvn_budyko_plot` to generate a budyko curve from model precip, AET, and PET;\n  - updates to rvi mapping, including improvements to add functionality from `ggrepel` library\n    in spacing labels, and addition of the `DiagrammeR` library to support `rvn_rvi_process_diagrammer`;\n  - `rvn_budyko_plot` to generate a budyko curve from model precip, AET, and PET;\n  - updates to handling rvt reading and writing, which is now generic for all rvt types; and\n  - `rvn_met_interpolate` for performing inverse distance weighting interpolation to fill \n    missing data values in meteorological data (works immediately with `weathercan` downloads).\n\n### 2.0.0\n\nMajor updates to the package, including core package styling such as\nfunction case, naming conventions, and use of ggplot2 libraries for\nplotting. Some of these include:\n\n  - all core RavenR functions have an ‘rvn\\_’ prefix to specify the\n    package origin;  \n  - functions and input/output variables now use an underscore naming\n    convention, rather than periods or camelCase;  \n  - ggplot2 is now the default plotting library for plotting functions,\n    and some plotting arguments have been reduced, as ggplot objects may\n    be modified in post-production by the user;  \n  - many new functions added;  \n  - new sample data sets and examples, including tidying of all function\n    examples and addition of netcdf files to test netcdf-related\n    functions; and  \n  - multiple bug fixes and improvements to handling rvi, rvh, and\n    writing rvt files.\n\n## See Also\n\n* [RavenR.extras](https://github.com/rchlumsk/RavenR.extras): Additional RavenR utilities.\n\n* [Raven Hydrologic Modelling Framework](https://raven.uwaterloo.ca/): Robust and flexible Hydrologic Modelling Framework developd by Dr. James R. Craig at the University of Waterloo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frchlumsk%2Fravenr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frchlumsk%2Fravenr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frchlumsk%2Fravenr/lists"}