Skip to content

Ehyaei/RTLNotes

Repository files navigation

RTLNotes logo

RTLNotes

R build status

RMarkdown enables you to write reproducible academic publications such as articles, PhD thesis, lab reports, posters, presentations, and a variety of other fascinating documents using the lightweight and plain-text Markdown syntax. There are several packages for RMarkdown themes, but all of them are useful for left-to-right languages. RTLNotes package tries to create a right-to-left languages theme for RMarkdown.

RTLNotes is not only for R users!. Python programmers can also run codes in Rmarkdown. This article has additional information.

When running your Rmd files with knitr, output plots, tables and code results are embedded in the md file. Then, Rstudio by using pandoc’s powerful engine can convert your documents to many formats, such as PDF, Docx, HTML, epub, and… In particular, you can create PDF reports without worrying about the lateX code.

Features

The RTLNotes package contains report and presentation templates in PDF and Gitbook formats. In the articles section, you’ll find an introduction to each template as well as instructions on how to config it. The templates that have been implemented so far are as follows:

Installation

RTLNotes is not (yet) available on CRAN, so install development version from GitHub via the devtools or remotes packages.

🛑 🚧 Before installing the package, you should check that you have X11 plotting device, Parastoo, Vazir and Vazir-Code fonts on your machine. The fonts source can be found here. For more details on package dependencies, see Get Started.

# install.packages("remotes")
remotes::install_github("Ehyaei/RTLNotes")

Attribution

The RMarkdown packages and latex resources that inspired this effort include: