README.Rmd vs README.md

bcgov / bcgovr

An R package to automate set up and sharing of R projects in bcgov GitHub following bcgov guidelines

Apache License 2.0

34 stars 5 forks source link

README.Rmd vs README.md #19

Closed ateucher closed 7 years ago

ateucher commented 7 years ago

In analysis_skeleton() and package_skeleton(), (and further down the stack in add_readme()), if the rmarkdown = TRUE, then both a README.md and README.Rmd are added to the directory - Is this necessary, or should just the .Rmd be added? @boshek @stephhazlitt

ateucher commented 7 years ago

Relevant code here: https://github.com/bcgov/bcgovr/blob/master/R/add_meta.R#L33-L41

boshek commented 7 years ago

I think only add the .Rmd. I think that was my oversight.

ateucher commented 7 years ago

Cool, thanks. I'll fix that.

stephhazlitt commented 7 years ago

Agreed. So the default will be a README.md file, and if user adds rmarkdown=TRUE the folder will be populated with the README.Rmd only?

ateucher commented 7 years ago

I agree with that default for analysis_skeleton for sure - how about default rmarkdown = TRUE for package_skeleton?