{remedy} est sur le CRAN

Après avoir vécu plus d’un an sur GitHub, le package {remedy} est désormais disponible sur le CRAN. 

Faciliter l’écriture avec Markdown

À propos de {remedy}

Avez-vous déjà resenti de la frustration en écrivant en Markdown? Oui, formatter le texte devrait être simple — du moins aussi simple que ce qu’on trouve dans n’importe quel éditeur de texte.

Bonne nouvelle, nous avons la solution ! {remedy} est un package qui permet de faciliter l’écriture en Markdown, et de vous rendre plus efficace dans RSudio. En quelques mots, ce package apporte une expérience proche de l’éditeur de texte pour ce qui est du formattage.

Voici un exemple :

Raccourcis disponibles

Voici la liste des éléments disponibles :

  • align_arrow / align_equal alignent les opérateurs d’assignation.
  • backtickr met du texte entre backticks.
  • boldr / italicsr / striker gras, italique, rayé.
  • chunkr / chunknamer / chunkr_doc / chunkr_section / chunksplitr manipulent les chunks.
  • footnoter permet la création d’une note de pied de page.
  • h1r:h6r créent des headers (de H1 à H6).
  • htmlcommentr ajoute des commentaires HTML.
  • imager / urlr / youtuber prend une url et met les tags adéquats.
  • latexr ajoute des tags LaTeX.
  • listr / olistr transforme une série de ligne en liste.
  • rightr copie un élément sur la droite.
  • tabler génère une table markdown.
  • xaringanr insère le pull-left pull-right de {xaringan}.

Configuration

Installation

Installer {remedy} depuis le CRAN ou depuis GitHub:

# From CRAN
install.packages("remedy")
# From GitHub
remotes::install_github("ThinkR-open/remedy")

Notez qu’une fois installé, vous n’avez pas besoin de lancer le paquet pour utiliser les raccourcis.

Keyboard shortcuts

Bien sûr, l’idée n’est pas de sélectionner le texte, d’aller dans votre liste d’addins, de chercher le bon addin, et de faire la transformation : vous devez lier le contenu de {remedy}aux raccourcis clavier.

Si jamais vous voulez faire cela, vous pouvez le faire manuellement via Tools > Modify Keyboard Shortcuts.

Vous pouvez également utiliser le paquet{rsam} – soit avec les raccourcis recommandés :

remedy::remedy_opts$get('hotkeys')
#>           backtick               bold              chunk 
#>       "Ctrl+Cmd+`"       "Ctrl+Cmd+B"   "Ctrl+Alt+Cmd+C" 
#>         chunksplit          chunkname           footnote 
#> "Ctrl+Shift+Alt+C" "Ctrl+Shift+Alt+N" "Ctrl+Cmd+Shift+6" 
#>                 h1                 h2                 h3 
#>       "Ctrl+Cmd+1"       "Ctrl+Cmd+2"       "Ctrl+Cmd+3" 
#>                 h4                 h5                 h6 
#>       "Ctrl+Cmd+4"       "Ctrl+Cmd+5"       "Ctrl+Cmd+6" 
#>        htmlcomment              image            italics 
#>       "Ctrl+Alt+C"       "Ctrl+Cmd+P"       "Ctrl+Cmd+I" 
#>              latex               list              right 
#>       "Ctrl+Cmd+L" "Ctrl+Shift+Cmd+="    "Alt+Cmd+Right" 
#>             strike              table                url 
#>       "Ctrl+Cmd+S"       "Ctrl+Cmd+T"       "Ctrl+Cmd+U" 
#>           xaringan            youtube 
#>       "Ctrl+Cmd+X"       "Ctrl+Cmd+Y"

hotkeys <- remedy::remedy_opts$get("hotkeys")
rsam::set_shortcut(sprintf('remedy::%sr',names(hotkeys)), hotkeys)

Soit avec les vôtres.

Contribuer

Si vous avez trouvé un bug ou souhaitez participer ? Ouvrez une issue : https://github.com/ThinkR-open/remedy/issues.