Skip to content

pzhaonet/rmd

Repository files navigation

rmd: Easily Install and Load the R Markdown Family

Project Status: Active - The project has reached a stable, usable state and is being actively developed. CRAN_Status_Badge CRAN Downloads GitHub forks GitHub stars

Introduction

Since 'rmarkdown' and 'knitr', more and more members (rticles, bookdown, mindr...) have been joining the R Markdown family. The installation and maintenance becomes annoying. With 'rmd' you can easily install and load them. Furthermore, 'rmd' provides a RStudio addin to explore the R Markdown family.

Forget R, and enjoy the wonderful world of R Markdown.

Quick start

Installation

When you install 'rmd', the R Markdown family members are installed in one single step:

# stable version:
install.packages("rmd")
# or development version:
remotes::install_github("pzhaonet/rmd")

Load

require('rmd')
>> Loading required package: rmd
>> -- Attaching packages --------------------------------------------- rmd 0.1.3 --
>>rmarkdown    1.11.2tinytex      0.9   
>>knitr        1.21xaringan     0.8   
>>bookdown     0.9citr         0.2.0 
>>blogdown     0.10mindr        1.1.10
>>rticles      0.6bookdownplus 1.5.4 

Addin

'rmd' provides an RStudio addin. Click the 'Addins' button on the tool bar and find 'R Markdown Family' under 'RMD'. A table of suggested R markdown packages will pop out. A package in a green row has already been installed. Click a row to install or remove the package.

Other functions

rmd_conflicts()
rmd_deps()
rmd_packages()
rmd_update()
rmdAddin()

List of R markdown family members

See https://github.com/pzhaonet/rmd/tree/master/static.

If you made a useful package for the R markdown family, feel free to make a pull request on GitHub to add it to the list.

License

Copyright Peng Zhao.

Released under the GPL-3 license.