Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GegznaV/addins.rmd
:heavy_check_mark: Add-ins to format R Markdown documents in RStudio (R package)
https://github.com/GegznaV/addins.rmd
r rstudio-addin
Last synced: 8 days ago
JSON representation
:heavy_check_mark: Add-ins to format R Markdown documents in RStudio (R package)
- Host: GitHub
- URL: https://github.com/GegznaV/addins.rmd
- Owner: GegznaV
- License: mit
- Created: 2018-02-26T09:18:29.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-08T12:39:22.000Z (over 1 year ago)
- Last Synced: 2024-08-13T07:13:51.806Z (4 months ago)
- Topics: r, rstudio-addin
- Language: R
- Homepage: https://gegznav.github.io/addins.rmd/
- Size: 5.39 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - GegznaV/addins.rmd - :heavy_check_mark: Add-ins to format R Markdown documents in RStudio (R package) (R)
README
---
output: github_document
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
[](https://opensource.org/licenses/MIT)
[](https://cran.r-project.org/package=addins.rmd)
[![GitHub version](https://img.shields.io/badge/GitHub-`r packageVersion("addins.rmd")`-brightgreen.svg)](https://github.com/GegznaV/addins.rmd)
[](https://github.com/GegznaV/addins.rmd/actions)
[)`-yellowgreen.svg)](/commits/master)
***
# 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:
```{r Install package from CRAN, eval=FALSE}
repos <- c("https://mokymai.github.io/download/", getOption("repos"))
install.packages("addins.rmd", repos = repos)
```
Install from GitHub
Install development version from GitHub:
```{r Install package from GitHub, eval=FALSE}
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.
```{r steps-search-addins, echo=FALSE, fig.cap=CAPTION, out.width=400}
knitr::include_graphics("https://gegznav.github.io/addins.rmd/figs/steps-search-addins.png")
CAPTION <- "**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
```{r fig-ID-1, echo=FALSE, fig.cap=CAPTION, out.width=600}
CAPTION <- "**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.)*"
knitr::include_graphics("https://gegznav.github.io/addins.rmd/figs/demo-headings-1.gif")
```
```{r fig-ID-2, echo=FALSE, fig.cap=CAPTION, out.width=600}
CAPTION <- "**Fig. 3.** Demonstration 2: headings.** Notice that, if needed, a blank line above the selection is added. "
knitr::include_graphics("https://gegznav.github.io/addins.rmd/figs/demo-headings-2.gif")
```
## Basic Text Formatting
```{r fig-ID-3, echo=FALSE, fig.cap=CAPTION, out.width=600}
CAPTION <- "**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.)* "
knitr::include_graphics("https://gegznav.github.io/addins.rmd/figs/demo-formatting-1.gif")
```
## Create Lists
```{r fig-ID-4, echo=FALSE, fig.cap=CAPTION, out.width=600}
CAPTION <- "**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.)* "
knitr::include_graphics("https://gegznav.github.io/addins.rmd/figs/demo-lists-1.gif")
```
## Create R Code Chunks
```{r demo-chunk-add-1, echo=FALSE, fig.cap=CAPTION, out.width=600}
CAPTION <- "**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. "
knitr::include_graphics("https://gegznav.github.io/addins.rmd/figs/demo-chunk-add-1.gif")
```
# 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](https://rstudio.github.io/rstudioaddins/);
2. [Keyboard shortcuts](https://rstudio.github.io/rstudioaddins/#keyboard-shorcuts);
3. [Customizing keyboard shortcuts.](https://support.rstudio.com/hc/en-us/articles/206382178-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:
- [https://pandoc.org/MANUAL.html#pandocs-markdown](https://pandoc.org/MANUAL.html#pandocs-markdown){target="_blank"}
***
Online docuentation at http://gegznav.github.io/addins.rmd/