search

ArgoCanada / argodata

Download Argo Ocean Float Data
https://argocanada.github.io/argodata
Other
8 stars 3 forks source link

Include a snapshot of R environment or package version info #40

Open KimBaldry opened 3 years ago

KimBaldry commented 3 years ago

This may help users in the future and is god practice. See here for example: https://blog.rstudio.com/2019/11/06/renv-project-environments-for-r/

paleolimbot commented 2 years ago

Where would this fit best into the submission? The documentation is always rendered using the latest available CRAN packages...would the paper be a better place for this information?

paleolimbot commented 2 years ago

(just for cross-linking with the review thread: https://github.com/openjournals/joss-reviews/issues/3659 )

KimBaldry commented 2 years ago

It should be a .lock file at the top of your repository. It is just so of another package updates, like dplyr, and brakes the code then the user can figure out why the code is not working (because they have a higher or lower version of dplyr), and reload the environment you used to package the code using the .lock file. Does that make sense? I have had it happen to me before and too some sleuthing to figure out what was going on.

You can put a line of code stating the purpose of the .lock file in the README