search

LieberInstitute / qsvaR

Quality Surrogate Variable Analysis for Degradation Correction
http://research.libd.org/qsvaR/
0 stars 2 forks source link

Update README files #7

Closed lcolladotor closed 2 years ago

lcolladotor commented 3 years ago

Once you have a main function you want to showcase, update the Example section at https://github.com/LieberInstitute/DeDHed/blob/main/README.Rmd#L42-L65.

Once you have updated the main description of the package (the paragraph at #1), then you can update the goal at https://github.com/LieberInstitute/DeDHed/blob/main/README.Rmd#L23.

To update the README.md file, use https://github.com/LieberInstitute/DeDHed/blob/main/dev/04_update.R#L29.

lcolladotor commented 3 years ago

Note that you might have to manually delete https://github.com/LieberInstitute/DeDHed/blob/53103928435e2fdade736de338d52bb08cc3ec36/man/figures/README-pressure-1.png once you update the example.

That figure is made from https://github.com/LieberInstitute/DeDHed/blob/53103928435e2fdade736de338d52bb08cc3ec36/README.Rmd#L61-L63

https://github.com/LieberInstitute/DeDHed/blob/53103928435e2fdade736de338d52bb08cc3ec36/README.Rmd#L11 influences where the figure is saved and how it's named

joshstolz commented 2 years ago

Readme file was updated and completed