{remedy} provides addins to facilitate writing in markdown with RStudio.

All the functions are meant to be mapped to keyboard shortcuts. A list of suggested shortcuts is provided towards the end of this README.

Note that most of the addins/shortcuts below will also work without selecting any text.

Install

remotes::install_github("ThinkR-open/remedy")

Once you’ve installed the package, you don’t need to load it with library(), the addins are installed on your machine as part of the package install process.

Using {remedy}

Write quicker in markdown with {remedy}!
Read the full manual in the associated {pkgdown} website: https://thinkr-open.github.io/remedy/

Here’s a list of all available helpers:

You can also have an overview of how the functions behave with the remedy_example() function:

library(remedy)
remedy_example( c("Never gonna", "give you up", "let you down"), listr )

Align

Align selected blocks to their assignment operator, either <-

or =

Backtick

Enclose the selected word(s) in backticks.

Blockquote

Turn selected line(s) to blockquote.

Chunk

Turn the selected text into a chunk.

Note that every chunk is given a name.

chunksplit split the chunk at a given spot.

Emphasize

Embolden, italicize or strikethrough the selected text.

Footnotes

Turn the given text into a footnote.

Headers

Turn the selected text into a header.

HTML Comment

Turn the text into an html comment

Image

Turn the selected path into an image.

This element is context aware: if you select a text and a link, it turns the text into title between ![], and puts the link between ().

If the last element of the selection is not a link, you get an error message straight into you markdown document.

LaTeX

LaTeX syntax :

List

Turn the selected text into an unordered list.

Moving

On the right

Copy the selected text or the current line to the right.

Table

Insert a table inside your doc.

There are basically two way to do that with remedy :

Ttable

Parse your data

Turn your dataframe into a markdown table :

URL

Turn the selected text into a link.

This element is context aware: if you select a text and a link, it turns the text into title between [], and puts the link between ().

If the last element of the selection is not a link, you get an error message straight into you markdown document.

Youtube

Turn an url into a youtube embed:

xaringan

Insert a xaringan pull-left and pull-right template.

Feedback and enhancement

You’ve found a bug, or have an enhancement idea? Feel free to open an issue : https://github.com/ThinkR-open/remedy/issues.

Code of conduct

Please note that the ‘remedy’ project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.