Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 2.03 KB

README.md

File metadata and controls

62 lines (44 loc) · 2.03 KB

acronym

Lifecycle: experimental CRAN status R build status

The goal of acronym is to help finding acronyms in a Word document so you can create a list of abbreviations for your manuscript submission.

Installation

You can install the development version of acronym from GitHub with:

# install.packages("remotes")
remotes::install_github("fmmattioni/acronym")

Example

library(acronym)

find_acronyms(path = system.file("zotero.docx", package = "acronym"), ref_manager = "zotero")
#> ✓ List of acronyms copied to clipboard. You can now just paste it into your Word document.
#>  [1] "CCC"      "CP"       "CP1/time" "CP2-hyp"  "CP3-hyp"  "CPexp"   
#>  [7] "CPlinear" "HR"       "LOOCV"    "Pmax"     "POpeak"   "TTE"     
#> [13] "V̇O2max"   "W’"

Copy it directly into your Word document!

knitr::include_graphics("man/figures/demo.gif")

The way it works

acronym is going to search only for acronyms in your manuscript that are between brackets. Please, note that this is still experimental, so ultimately you should double-check the list of abbreviations retrieved. Got any ideas and/or tips for improving the code? Feel free to open an issue or submit a PR!

Code of Conduct

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