README.md

HBM_Rmarkdown_template

Human Brain Mapping Rmarkdown template

UNDER DEVELOPMENT

Installation

PLEASE NOTE THAT THE INSTALL INSTRUCTIONS ARE DIFFERENT TO NORMAL. To install, download only the 'WileyHBMtemplate_0.1.0.tar.gz' zip file and then install package using

install.packages("WileyHBMtemplate_0.1.0.tar.gz", repos = NULL)

Overview

The HBM_Rmarkdown_template package provides a custom R Markdown LaTeX format and template for:

Under the hood, LaTeX templates are used to ensure that documents conform precisely to submission standards. At the same time, composition and formatting can be done using lightweight markdown syntax, and R code and its output can be seamlessly included using knitr.

Using HBM_Rmarkdown_template requires the prerequisites described below. You can get most of these automatically by installing the latest release of RStudio and rticles (instructions for using rticles without RStudio are also provided).

Using rticles from RStudio

To use rticles from RStudio:

  1. Install the latest RStudio.

  2. Install the rticles package.

  3. Use the New R Markdown dialog to create an article from one of the templates:

    New R Markdown

Using rticles outside of RStudio

  1. Install pandoc using the instructions for your platform.

  2. Install the rticles packages.

  3. Use the rmarkdown::draft() function to create articles:

    r rmarkdown::draft("MyJSSArticle.Rmd", template = "jss_article", package = "rticles") rmarkdown::draft("MyRJournalArticle", template = "rjournal_article", package = "rticles")



p1981thompson/HBM_Rmarkdown_template documentation built on Dec. 3, 2019, 12:42 a.m.