usgs-r / cyan Goto Github PK
View Code? Open in Web Editor NEWLicense: Creative Commons Zero v1.0 Universal
License: Creative Commons Zero v1.0 Universal
Following rOpenSci's review template:
https://devguide.ropensci.org/
https://ropensci.org/software-review/
https://github.com/ropensci/software-review/
Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide
The package includes all the following forms of documentation:
I might change it to:
remotes::install_github("USGS-R/CyAN", build_vignettes = TRUE
The remotes
package has fewer dependencies than devtools
, devtools
is only re-exporting the remotes
function anyway, and the "build_vignettes" argument should be set to TRUE so users can easily use the vignette.
URL
, BugReports
and Maintainer
(which may be autogenerated via Authors@R
).Consider using Authors@R in the DESCRIPTION file:
Here's my info for instance:
Authors@R: c(
person("Laura", "DeCicco", role = c("aut","cre"),
email = "[email protected]",
comment=c(ORCID="0000-0002-3915-9487"))
Then maybe add:
BugReports: https://github.com/USGS-R/dataRetrieval/issues
In the app, it might be nice to have a button to "Load Example Data"...or maybe print out what the user's:
system.file("extdata", "example.db", package = "CyAN")
Once I click a .db file successfully, it would be great to get some feedback from the app (like, right in the "Connect to database" tab. Just a simple "Success!" message maybe.
I like the NHD layer option!!!
Moving on to the Bivariate plot, it would be schnazzy if the drop-downs filtered out the parameters that don't have data. I had to really poke around to find one that worked (since I was just using the example data)
R code review:
I'm generally not a fan of using pipes in package functions. The reason for this is that the user gets less information if there's an error and they are reading the traceback. With pipes, you only know if failed somewhere. With no pipes, you know if failed on the inner_join or whatever.
I'd consider adding a travis check, something like:
https://github.com/USGS-R/EGRET/blob/master/.travis.yml
This makes sure any changes in the future don't break your tests. In that same travis example, travis then sends a check out to "coveralls"...which is a way to check how well your tests cover your code. It's helpful to see these things on each pull request so you know if you've screwed up or not ๐.
You shouldn't get an error when you haven't selected the parameter. It should just output nothing, and it would be nice if the plots were labeled, too.
The master
branch of this repository will soon be renamed from master
to main
, as part of a coordinated change across the USGS-R and USGS-VIZLAB organizations. This is part of a broader effort across the git community to use more inclusive language. For instance, git, GitHub, and GitLab have all changed or are in the process of changing their default branch name.
We will make this change early in the week of February 6, 2022. The purpose of this issue is to give notification of the change and provide information on how to make it go smoothly.
When this change is made, forks and clones of the repository will need to be updated as well. Here are instructions for making the necessary changes.
master
to main
(<your repository> -> Settings -> Branches).First, update your local git configuration so that new repositories created locally will have the correct default branch: git config --global init.defaultBranch main
.
Now, for any forks, do the following:
master
to main
.git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a
How do I connect the CyAN R package with the larger CyAN database? I read through the vignette and I see how the example uses a small local version that's included. How can I acquire a local version of the larger database? Or is there a way to connect to the database without a local version?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.