New code should follow the tidyverse style guide.
If you decide to use RMarkdown for a specific task, put the .Rmd souce in analysis/, use github_document as the output (if it doesn't have interactive visualizations), and select "Knit from directory." The .md files generated can then be previewed on GitHub.
If you define reusable functions in your analysis workflow, it is recommended that you include them in the pricingtutorial companion package, which also lives in this repo. Add the functions to R/ and document them appropriately, and include tests as appropriate. See R Packages for more information on R packages.
The latest version of the tutorial is hosted at https://pricing-tutorial.netlify.com/. To make changes:
- Fork the repo and create a new branch.
- Modify
manuscript/article.Rmd. - Run the build script
manuscript/build_article_preview.R. - If you're happy with what you see in
manuscript/public/index.html, send a PR.
Once the PR is created, a preview version should be deployed and you'll be able to see it in the build details.
Check out http://happygitwithr.com/. Also feel free to ask questions in the gitter channel.