Skip to content

02. New Post Workflow

Michael McCarthy edited this page Nov 10, 2021 · 4 revisions

Creating New Posts

New posts should be created in a new branch. The R Markdown file for a post can be created using the New Post (from Template) RStudio addin from the distilltools package.

Once the new post file is created, it should be committed and pushed to GitHub, and then a Pull Request should be started. This will trigger Netlify’s deploy previews.

New Post Contents

The R Markdown file for the new post should generally follow these guidelines.

YAML

Affiliation

The affiliation should be something related to the topic of the post. This is meant to be a fun easter egg.

Body

The typical post should…

Appendix

Data

The data source for an article should be provided to readers in a Data Source section in the article appendix. Data can be provided in two ways:

  • For articles that use data downloadable with a function call (e.g., Tidy Tuesday data with tidytuesdayR) the code should be provided.
  • For articles that create their own data a link should be provided.

Citations

See the Distill documentation.

Sources can be included in the References section of an article appendix using standard R Markdown notation, or by using the nocite YAML parameter.

bibliography: sources.bib
csl: ../../inst/csl/mla.csl
nocite: | 
  @omni_projectile_nodate, @lumen_projectile_nodate, @khan_projectile_nodate

The citation language style used for posts should be ….

ZoteroBib can be used to create BibTeX .bib files from a list of URLs.

Return to Tidy Tales or my Personal Site

Clone this wiki locally