Skip to content

✔️ Add-ins to format R Markdown documents in RStudio (R package)

License

Notifications You must be signed in to change notification settings

GegznaV/addins.rmd

Repository files navigation

MIT licensed CRAN_Status_Badge GitHub version R-CMD-check Updated-on


R package addins.rmd

Package addins.rmd is an R package that provides a set of RStudio add-ins for R Markdown. The main purpose of this package is to alleviate learning process of R Markdown syntax.

Install Package

Install package from CRAN-like repository:

repos <- c("https://mokymai.github.io/download/", getOption("repos"))
install.packages("addins.rmd", repos = repos)
Install from GitHub

Install development version from GitHub:

if (!require(remotes)) {
  install.packages("remotes")
}

remotes::install_github("GegznaV/addin.tools")
remotes::install_github("GegznaV/addins.rmd")

How to Use Thse Add-ins

For the current version of the package:

  1. Find and click RStudio “Addins” button;
  2. Type {Rmd} in the add-ins search box;
  3. All the add-ins of the package addins.rmd will be displayed in the drop-down list below.

**Fig. 1.** Steps to find addins of the package **addins.rmd**.

Below you can find a few examples how to use the add-ins of the package.

Convert Text into Headings

**Fig. 2.** **Demonstration 1: headings.**
Place a cursor with a mouse and use a necessary add-in.
*(In this demonstrations, older version of the package is used.)*


**Fig. 3.** Demonstration 2: headings.** Notice that, if needed, a blank line above the selection is added.

Basic Text Formatting

**Fig. 4.** **Demonstration 3: basic formatting.**
Before using this type of add-in, select a piece of text that should be formatted.
*(In this demonstrations, older version of the package is used.)*

Create Lists

**Fig. 5.** **Demonstration 4: lists.**
The lists can be numbered and unnumbered.
They can have several levels.
*(In this demonstrations, older version of the package is used.)*

Create R Code Chunks

**Fig. 6.** **Demonstration 5: R code chunks.**
Select one or several lines with code, select an appropriate add-in and include code into a chunk.

See Also

Use the links below to learn more about RStudio add-ins and especially how to use them in combination with user-defined keyboard shortcuts:

  1. RStudio add-ins;
  2. Keyboard shortcuts;
  3. Customizing keyboard shortcuts.

Pandoc’s Markdown

R Markdown syntax is based on Pandoc’s Markdown syntax. If you need more advanced formatting options, please, read more at:


Online docuentation at http://gegznav.github.io/addins.rmd/

About

✔️ Add-ins to format R Markdown documents in RStudio (R package)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors 3

  •  
  •  
  •  

Languages