README.md

In dshelldhillon/markdowntemplate: Creates a Rmarkdown template

markdowntemplate

The goal of markdowntemplate is to provide the least resistance path to adoption of reproducible reporting using Rmarkdown documents. Below are some helpful resources to get started with Rmarkdown -

1. Rmarkdown Book This book is an exhaustive ressource for all things Rmarkdown
2. Pimp my Rmarkdown This resource provides resources on how to customize Rmarkdown reports
3. Why Rmarkdown Another resource if you aren’t convinced already

In addition, this package provides vignettes that provide examples of the analysis frequently encountered by the statistical engineering group. The purpose of these documents is to help new joiners get on board quickly. The list of planned vignettes are

1. One-way and two way anova   
    a. All pairwise comparisons    
    b. All to control comparisons   
    c. Custom contrasts (only some pairwise comparisons)     
2. Split plot models     
    a. How to analyze split plot models in R    
    b. Satterwhite vs Kenward Roger Degree of Freedom     
    c. Pairwise comparisons    

Installation

This package will probably never make it’s way to CRAN so it will need to be installed from github like so :

#if (!require("devtools")) install.packages("devtools")
# library(devtools)  
# devtools::install_github(dshelldhillon/markdowntemplate) 
# 
# library(markdowntemplate) 

You may have to restart your R session after installing the package to enable the Rmarkdown templates

This package also imports and installs the following recommended packages :

magrittr (>= 1.5),
emmeans (>= 1.3.3),
forcats (>= 0.4.0),
stringr (>= 1.4.0),
purrr (>= 0.3.2),
readr (>= 1.3.1),
tidyr (>= 0.8.3),
tibble (>= 2.1.1),
ggplot2 (>= 3.1.0),
rmarkdown (>= 1.13),
readxl (>= 1.3.1),
usethis (>= 1.5.0),
fs (>= 1.3.1),
here (>= 0.1)

Example

From the drop down menu, select File > New File > R markdown document > From Template > …

As of 19 March, 2020, there is one template RMD available that provides a skeleton for a Floating Table of Contents style document.

New Project Workflow If you’re starting a new project, the function directory_setup creates an opinionated directory structure that every project typically consists of.

Project Name/
├── Data/
|   └── raw
|   └── processed
├── Notebooks/
├── Scripts/
├── Misc/
├── tmp/

#library(markdowntemplate)
## directory_setup()

Vignettes

dshelldhillon/markdowntemplate documentation built on March 21, 2020, 4:44 a.m.