create the package

Author: tjmahr

.Rbuildignore

@@ -0,0 +1,3 @@
+^.*\.Rproj$
+^\.Rproj\.user$
+demo.gif

.gitignore

@@ -17,3 +17,4 @@ vignettes/*.pdf
 
 # OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
 .httr-oauth
+.Rproj.user

DESCRIPTION

@@ -0,0 +1,14 @@
+Package: WrapRmd
+Title: RStudio Addin for Wrapping RMarkdown Paragraphs
+Version: 0.0.0.9000
+Authors@R: person("Tristan", "Mahr", email = "[email protected]", role = c("aut", "cre"))
+Description: Provides an RStudio addin for wrapping paragraphs in an RMarkdown document without inserting linebreaks into spans of inline R code.
+Depends:
+    R (>= 3.2.3)
+License: MIT + file LICENSE
+LazyData: true
+Imports:
+    stringr,
+    rstudioapi,
+    stringi
+RoxygenNote: 5.0.1

LICENSE

@@ -0,0 +1,5 @@
+# Generated by roxygen2: do not edit by hand
+
+export(str_rmd_wrap)
+export(wrap_rmd_addin)
+import(stringr)

NAMESPACE

@@ -0,0 +1,65 @@
+#' WrapRmd
+#'
+#' Provides an RStudio addin for wrapping paragraphs in an RMarkdown document
+#' without inserting linebreaks into spans of inline R code.
+#'
+#' @name WrapRmd
+#' @docType package
+#' @import stringr
+NULL
+
+
+
+#' Wrap text but don't insert lines breaks into inline R code
+#' @param string a string to wrap
+#' @param width,indent,exdent other arguments for stringr::str_wrap
+#' @return a wrapped copy of the string
+#'
+#' @details This function finds all inline R code spans in a string, replaces
+#'   all non-word characters and spaces the inline R spans with underscores,
+#'   wraps the string and restores the original inline R spans.It's not going to
+#'   handle any inline code that uses backticks.
+#' @export
+str_rmd_wrap <- function(string, width = 80, indent = 0, exdent = 0) {
+  stopifnot(length(string) == 1)
+  output <- string
+
+  inline_code <- str_extract_all(string, "(`r)( )([^`]+`)") %>% unlist
+
+  # Just wrap if no code
+  if (length(inline_code) == 0) {
+    return(str_wrap(string, width, indent, exdent))
+  }
+
+  # Make R code chunks into to long words
+  spaceless_code <- inline_code %>% str_replace_all("\\W| ", "_")
+
+  for (i in seq_along(inline_code)) {
+    output <- str_replace(output, coll(inline_code[i]), spaceless_code[i])
+  }
+
+  # Wrap
+  output <- str_wrap(output, width, indent, exdent)
+
+  # Put original code chunks back
+  for (i in seq_along(inline_code)) {
+    output <- stringi::stri_replace_first_coll(
+      str = output,
+      pattern = spaceless_code[i],
+      replacement = inline_code[i])
+  }
+
+  output
+}
+
+
+#' Wrap text but don't insert lines breaks into inline R code
+#'
+#' Call this addin to wrap paragraphs in an R Markdown document
+#' @export
+wrap_rmd_addin <- function() {
+  context <- rstudioapi::getActiveDocumentContext()
+  selection <- context$selection
+  text <- unlist(selection)["text"]
+  rstudioapi::insertText(str_rmd_wrap(text))
+}

R/WrapRmd-package.r

@@ -1 +1,38 @@
 # WrapRmd
+
+An [RStudio Addin](https://rstudio.github.io/rstudioaddins/) to wrap paragraphs
+of RMarkdown text.
+
+## Overview
+
+Here is some nice looking R Markdown:
+
+```
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum a `r max(iris$Sepal.Length)`, viverra nisl at, luctus ante = `r length(letters) * 2 + 100`.
+```
+
+You highlight the text, and hit ctrl/cmd + shift + / to wrap the text and get:
+
+```
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum a `r
+max(iris$Sepal.Length)`, viverra nisl at, luctus ante = `r length(letters) * 2 +
+100`.
+```
+
+This RStudio Addin wraps text, but doesn't insert line breaks into inline R
+code, yielding:
+
+```
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum
+a `r max(iris$Sepal.Length)`, viverra nisl at, luctus ante =
+`r length(letters) * 2 + 100`.
+```
+
+![An animation of the above](demo.gif)
+
+
+## Notes
+
+Install with `devtools::install_github("tjmahr/WrapRmd")`
+
+Currently, the package wraps lines using a maximum line width of 80 characters.

README.md

@@ -0,0 +1,21 @@
+Version: 1.0
+
+RestoreWorkspace: No
+SaveWorkspace: No
+AlwaysSaveHistory: No
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: knitr
+LaTeX: XeLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace,vignette

WrapRmd.Rproj

@@ -0,0 +1,4 @@
+Name: Wrap Rmd
+Description: Wrap selected R Markdown text but don't insert lines breaks into inline R code
+Binding: wrap_rmd_addin
+Interactive: false

demo.gif

@@ -0,0 +1,24 @@
+library("stringr")
+
+no_code <- "regular words on a line"
+str_rmd_wrap(no_code) %>% cat
+
+# Simple case
+text <- "
+`r hello` and `r 1 + 1` and `r 1 + b + b + c` and drop a line right here `r maybe_here` `r goodbye`
+"
+str_rmd_wrap(text) %>% cat
+
+# Paragraph I got frustrated manually re-wrapping
+original_test <- "
+Ignoring the quadratic and cubic features of the growth curve, the linear time^1^ term estimated an increase of `r ms_delta_bin` logits per 50 ms. At 0 logits (.5 proportion units), where the logistic function is steepest, an increase of `r ms_delta_bin` logits corresponds to an increase of `r ms_prop_change_50` proportion units. At chance performance (.25 proportion units), this effect corresponds to an increase of `r ms_prop_change_25` proportion units.
+"
+
+str_rmd_wrap(original_test) %>% cat
+
+
+gif_lines <- "
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum a `r max(iris$Sepal.Length)`, viverra nisl at, luctus ante = `r length(letters) * 2 + 100`.
+"
+
+str_rmd_wrap(gif_lines) %>% cat