signaturescience / skater

SKATE R Utilities
https://signaturescience.github.io/skater/
Other
9 stars 4 forks source link

Create a vignette #50

Closed stephenturner closed 3 years ago

stephenturner commented 3 years ago

Move readme stuff to an introductory vignette. Compiled vignette could be supplementary info in a bioinformatics app note (see #48)

vpnagraj commented 3 years ago

@stephenturner back over to you to review the basic usage vignette:

https://github.com/signaturescience/skater/commit/d3757f7e068e46c93c8253724b9a0df9d05bb2d1

i've also edited README to reference the vignette:

https://github.com/signaturescience/skater/commit/956ed62e19579a79df032bc3746a31d3f408cb2c

vpnagraj commented 3 years ago

note: wasn't sure the best way to reference the reciprocal RMSE in the vignette ... just used R code in footnote

stephenturner commented 3 years ago

Thanks! also, note to self, it's devtools::install(build_vignettes = TRUE) that I'm looking for