[New R Package] rmd: Easily Install, Load and Explore the R Markdown Family

in #utopian-io5 years ago (edited)



What is the project about?

Since 'rmarkdown' and 'knitr', more and more members (rticles, bookdown, mindr...) have been joining the R Markdown family. Users can write elegant reproducible documents, manuscripts, dissertations, books, blog posts, posters, and slides within the framework of R markdown. It is exciting, while the installation and maintenance becomes annoying. In the meanwhile, there are plenty of useful RStudio addins, which equip the RStudio IDE as a powerful markdown editor. However, these little tools are often hidden somewhere deep in the community, and it is difficult to dig them out.

With 'rmd' you can easily explore, install, and load them for both R users and non-users. Furthermore, 'rmd' provides a RStudio addin to explore the R Markdown family and install them with a single click.

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

What are the current features?

  • Load multiple functions with one command

    When 'rmd' is loaded, multiple useful markdown packages are loaded. Uses can directly write all kinds of documents with them.

>> Loading required package: rmd
>> -- Attaching packages --------------------------------------------- rmd 0.1.3 --
>> √ rmarkdown    1.11.2     √ tinytex      0.9   
>> √ knitr        1.21       √ xaringan     0.8   
>> √ bookdown     0.9        √ citr         0.2.0 
>> √ blogdown     0.10       √ mindr        1.1.10
>> √ rticles      0.6        √ bookdownplus 1.5.4 
  • 'rmd' provides four main functions currently.

    • rmd_conflicts(): check the conflicts of the functions in 'rmd' and other loaded packages.

    • rmd_deps(): list all the 'rmd' dependencies.

    • rmd_packages(): list all packages in 'rmd'.

    • rmd_update(): check to see if all rmd packages (and optionally, their dependencies) are up-to-date, and will install after an interactive confirmation.

  • '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.

List of R markdown family members

The R markdown family members in the 'rmd' addin can be found on GitHub. If you made a useful package for the R markdown family, feel free to make a pull request and add it to the list.

PackageDate AddedDescriptionOn CRAN?AuthorMore linksNotes
beautifyR2019-01-26RStudio addin for formatting Rmarkdown tables:x:Matthias WeigandDemo GIF
blogdown2019-01-26Create Blogs and Websites with R Markdown:white_check_mark:Yihui Xie et al.Doc
bookdown2019-01-26Authoring Books and Technical Documents with R Markdown:white_check_mark:Yihui Xie et al.Doc
bookdownplus2019-01-26The shortcut to the R package bookdown for writing varied types of books and documents:white_check_mark:Peng ZhaoGallery
caseconverter2019-01-26Convert text cases to lower, upper, snake, camel cases:x:strboulDemo GIF
citr2019-01-26Search a BibTeX-file and insert formatted Markdown citations:white_check_mark:Frederik AustDemo gif
drposter2019-01-26Generate Academic Posters in R Markdown and CSS, inspired by 'reveal.js':x:Ben BuciorDemo pdf
insertImage2019-01-26Insert image into R Markdown with file chooser. Copy image file to project.:x:Ludvig R Olsen
inserttable2019-01-26RStudio add-in facilitating insertion of nicely formatted tables in R markdown documents or plain R scripts.:x:Lorenzo BusettoBlog Post
knitr2019-01-26A general-purpose tool for dynamic report generation in R:white_check_mark:Yihui Xie et al.Blog Post
mindr2019-01-26Convert markdown files (.md, .Rmd) into mindmaps (brainstorms):white_check_mark:Peng ZhaoSlides
pagedown2019-01-26Paginate the HTML Output of R Markdown with CSS for Print:white_check_mark:Yihui Xie et al.Doc
regexplain2019-01-26Interactive regular expression utility belt:x:Garrick Aden-BuieDemo gifs
remedy2019-01-26RStudio Addins to Simplify Markdown Writing:x:ThinkRHow it works
rmarkdown2019-01-26Dynamic Documents for R:white_check_mark:JJ Allaire et al.Website
rmd2019-01-26Easily Installs and Loads the R Markdown Family:white_check_mark:Peng Zhao
rosr2019-01-26Create academic R markdown projects for open science and reproducible research:x:Peng Zhao
RStudioConsoleRender2019-01-26Render an R Markdown document in the global environment:x:Jeff JohnstonBlog post
rticles2019-01-26LaTeX Journal Article Templates for R Markdown:white_check_mark:JJ Allaire et al.
splitChunk2019-01-26Split code chunk in R Markdown:x:Ludvig R Olsen
strcode2019-01-26Insert code block separators and section titles:x:Lorenz WalthertDemo GIF
tinytex2019-01-26A lightweight, cross-platform, portable, and easy-to-maintain LaTeX distribution based on TeX Live:white_check_mark:Yihui Xie et al.Blog post
uniscape2019-01-26Convert non-ASCII strings to a portable format:x:Mikko KorpelaScreenshot
wellspell.addin2019-01-26Quick spellcheck with hunspell:x:Clemens Schmid
wordcountaddin2019-01-26Count non-code words in Rmd documents:x:Ben MarwickScreenshot
WrapRmd2019-01-26Wrap selected R Markdown text but don't insert lines breaks into inline R code:x:TJ Mahr
xaringan2019-01-26Create HTML5 slides with R Markdown and the JavaScript library 'remark.js':white_check_mark:Yihui Xie et al.Slides

Technology Stack

'rmd' is developed in R language.


The main structure of 'rmd' is more or less done. In the future, two things will be maintained.

  1. Keep an eye on useful R markdown packages and add the new ones into the R markdown family.
  2. Collect nice tools and maintain the addin list.

How to contribute?

Anyone can get in touch with me by leaving me a reply on steem @dapeng or on https://github.com/pzhaonet/rmd.


Thank you for your contribution @dapeng! It is nice to see you are back to @utopian-io !

  1. R folder could be better renamed to src.
  2. The zzz.R could be better renamed.
  3. It could be useful to have a few comments on top of each R saying what the R module does.
  4. A few more examples on how to use the package would be nice.

Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.

To view those questions and the relevant answers related to your post, click here.

Need help? Chat with us on Discord.


Thank you @justyy for your comments! Yeah, it is great to come back! Let me explain a little bit.

  1. As an R package, the R codes must be put in a folder named 'R'. Otherwise, the package cannot be compiled or accepted by CRAN, as far as I know.
  2. Yes, zzz.Rneeds a better name.
  3. Yes, a better documentation will be available in the future. I did it too soon.
  4. I agree. I will write a tutorial later.

Happy New year.

Thank you for your review, @justyy! Keep up the good work!

Hi @dapeng!

Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!
Your post is eligible for our upvote, thanks to our collaboration with @utopian-io!
Feel free to join our @steem-ua Discord server

@dapeng You have received a 100% upvote from @botreporter because this post did not use any bidbots and you have not used bidbots in the last 30 days!

Upvoting this comment will help keep this service running.

Hey, @dapeng!

Thanks for contributing on Utopian.
We’re already looking forward to your next contribution!

Get higher incentives and support Utopian.io!
Simply set @utopian.pay as a 5% (or higher) payout beneficiary on your contribution post (via SteemPlus or Steeditor).

Want to chat? Join us on Discord https://discord.gg/h52nFrV.

Vote for Utopian Witness!

Coin Marketplace

STEEM 0.27
TRX 0.11
JST 0.034
BTC 64746.45
ETH 3142.66
USDT 1.00
SBD 4.01