FlukeAndFeather / jese4sci-DOC

Documentation track of the jese4sci short course
0 stars 0 forks source link

DOC 102 #15

Open ShirleyJenniferSerranoRojas opened 2 years ago

ShirleyJenniferSerranoRojas commented 2 years ago

Critique a README Pick an R package that's important to your work. Find the README for that package. For example, here's the README for dbscan. GitHub is a good place to look, as are CRAN and Bioconductor. How does the README address the following?

Chosen package and readme file: https://github.com/tobiashofmann88/iucnsim/blob/master/README.md • Why should I use it? The readme file explains clearly the advantage of using this iucnsim package, as this offers a range of functions to quickly download all available IUCN RedList information for a group of species and to model status transitions rates. Both of which are novel implementations in R. There are two short paragraphs at the start of the file that explain the benefits of using the package. • How do I use it? The readme file provides a tutorial that guides the user through the whole workflow on how the package work including an example, clear inputs and outputs, and all well commented. • How do I get it? The readme file has a section that explains how to install the package providing all the links and an explanation of the database from where the data will be downloaded. In order to access the IUCN data, we need to apply for an IUCN API key so there is a section in the readme file that explains how to do this.

ShirleyJenniferSerranoRojas commented 2 years ago

https://github.com/ShirleyJenniferSerranoRojas/simplerc.git

mcgoodman commented 2 years ago

Hi Shirley - your answer to the first question is excellent, but I can't read your README for the second question since it's still an Rmd file and needs to be rendered in plain markdown! To do this, knit your README.Rmd, push the resulting README.md file to github, and link back to your repository.