search

FredHutch / VISCtemplates

Tools for writing reproducible reports at VISC
Other
6 stars 2 forks source link

Creates README.Rmd instead of README.md in new directory #214

Closed lemireg closed 1 month ago

lemireg commented 1 month ago

when running VISCtemplates::create_visc_project()

slager commented 1 month ago

The main advantage of having an .Rmd README is that you can include R code chunks in it.

To execute the code chunks and make an .md README from it, run devtools::build_readme().

If we never need/want to have an .Rmd README, we could change VISCtemplates to only create an .md file in the first place.

Or, if we always want to render the initial .Rmd README template into the .md version, we could have VISCtemplates do that as well. But that may be redundant if the user is always going to need to update the README from the initial template anyway.

kelliemac commented 1 month ago

you can also render README.md from README.Rmd using the Knit button in RStudio

lemireg commented 1 month ago

I am wondering if anyone is using the .Rmd. If everyone only uses .md file should it just be that? @kelliemac @slager Thanks for your feedback