The current README file is the default generated for BC Gov R Projects. It was created using bcgovr
There are actually two README files right now. The default is README.md which can be modified and used. There is also a README.Rmd. It is possible to include a step to render README.md from README.Rmd with each commit or as needed etc. This could be set up as a GitHub Action, I think. More info: https://usethis.r-lib.org/reference/use_readme_rmd.html
It's up to the UBC MDS team to decide if they prefer to work with the README in regular .md format or if they prefer the R-integration of .Rmd. Perhaps one will prove to be more useful as the project grows.
In addition, leaving the "usage", "example", and "project status" sections for the UBC MDS team to fill in as the project progresses. Feel free to add more sections if needed in this part of the README. Please leave the How to Contribute and License sections unchanged please.
The current README file is the default generated for BC Gov R Projects. It was created using bcgovr
There are actually two README files right now. The default is
README.mdwhich can be modified and used. There is also aREADME.Rmd. It is possible to include a step to renderREADME.mdfromREADME.Rmdwith each commit or as needed etc. This could be set up as a GitHub Action, I think. More info: https://usethis.r-lib.org/reference/use_readme_rmd.htmlIt's up to the UBC MDS team to decide if they prefer to work with the README in regular
.mdformat or if they prefer the R-integration of.Rmd. Perhaps one will prove to be more useful as the project grows.In addition, leaving the "usage", "example", and "project status" sections for the UBC MDS team to fill in as the project progresses. Feel free to add more sections if needed in this part of the README. Please leave the How to Contribute and License sections unchanged please.