https://github.com/ThinkR-open/remedy
RStudio Addins to Simplify Markdown Writing
https://github.com/ThinkR-open/remedy
hacktoberfest
Last synced: 5 months ago
JSON representation
RStudio Addins to Simplify Markdown Writing
- Host: GitHub
- URL: https://github.com/ThinkR-open/remedy
- Owner: ThinkR-open
- License: other
- Created: 2017-09-08T10:20:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-29T16:21:23.000Z (over 2 years ago)
- Last Synced: 2024-11-11T23:53:16.975Z (5 months ago)
- Topics: hacktoberfest
- Language: R
- Homepage: https://thinkr-open.github.io/remedy/
- Size: 74.8 MB
- Stars: 452
- Watchers: 17
- Forks: 34
- Open Issues: 21
-
Metadata Files:
- Readme: README.Rmd
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-rmarkdown - remedy: RStudio Addins to Simplify Markdown Writing
- jimsghstars - ThinkR-open/remedy - RStudio Addins to Simplify Markdown Writing (R)
README
---
output: github_document
---```{r, echo=FALSE, results=FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
# Copy reference/images to man/images
# reference folder is required to work with pkgdown
if (!dir.exists("man/figures")) {dir.create("man/figures")}
file.copy(list.files("reference/figures", full.names = TRUE),
"man/figures", overwrite = TRUE)
if (dir.exists("docs")) {
file.copy("reference/figures/thinkr-hex-remedy-favicon.ico",
"docs/favicon.ico", overwrite = TRUE)
}
```[](https://cran.r-project.org/package=remedy)
[](https://cran.r-project.org/package=remedy)[](https://travis-ci.org/ThinkR-open/remedy)[](https://codecov.io/github/ThinkR-open/remedy?branch=master)[](http://tinyurl.com/y76olv3v)
# remedy
`{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
```{r, eval = FALSE}
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:Here's a list of all available helpers:
You can also have an overview of how the functions behave with the `remedy_example()` function:
```{r eval = FALSE}
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.
### Cross references
ID, table and figure cross-reference
### 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.
## Recommended shortcuts (macOS)
Here's a list of recommended shortcuts:
```{r}
remedy::remedy_opts$get('hotkeys')
```### Managing Shortcuts
Use the [`{rsam}`](https://github.com/yonicd/rsam) package to set and manage for you the hotkey settings of `{remedy}`.
If you want to edit the default settings you can view the defaults `remedy_opts$get('hotkeys')` and change them through `remedy_opts$set(hotkeys=)`.
```{r, eval = FALSE}
hotkeys <- remedy::remedy_opts$get("hotkeys")
rsam::set_shortcut(sprintf('remedy::%sr',names(hotkeys)), hotkeys)
```## 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](https://github.com/ThinkR-open/remedy/issues).
## Code of conduct
Please note that the 'remedy' project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
