Update docs

DESCRIPTION

@@ -32,7 +32,7 @@ Imports:
     miniUI,
     jsonlite,
     rematch2
-RoxygenNote: 6.0.1
+RoxygenNote: 6.1.0
 Roxygen: list(markdown = TRUE)
 URL: https://github.com/gadenbuie/regexplain
 BugReports: https://github.com/gadenbuie/regexplain/issues

NEWS.md

@@ -1,5 +1,12 @@
 ## regexplain 0.2.x
 
+### 0.2.3
+
+* Use of `knitr` is automatically detected when calling `view_regex()` inside
+  an R Markdown document. The `knitr` parameter of `view_regex()` has been
+  removed. Added `result_only` parameter for interactive viewing. As a side
+  effect, the group coloring CSS is automatically embedded in the HTML output.
+
 ### 0.2.2
 
 * Fix issues with coloring of groups in regexplain gadget when matched groups

man/regexplain-package.Rd

@@ -6,11 +6,11 @@
 \alias{regexplain-package}
 \title{regexplain: Rstudio Addin to Explain, Test and Build Regular Expressions}
 \description{
-A set of RStudio Addins to help interactively test and build
-regular expressions. Provides a Shiny gadget interface for interactively
-constructing the regular expression and viewing the results from common
-string-searching functions. The gadget interface includes a helpful
-regex syntax reference sheet and a library of common patterns.
+A set of RStudio Addins to help interactively test and build 
+    regular expressions. Provides a Shiny gadget interface for interactively
+    constructing the regular expression and viewing the results from common 
+    string-searching functions. The gadget interface includes a helpful 
+    regex syntax reference sheet and a library of common patterns.
 }
 \seealso{
 Useful links:

man/run_regex.Rd

@@ -4,8 +4,8 @@
 \alias{run_regex}
 \title{Extract matched groups from regexp}
 \usage{
-run_regex(text, pattern, ignore.case = FALSE, perl = FALSE, fixed = FALSE,
-  useBytes = FALSE)
+run_regex(text, pattern, ignore.case = FALSE, perl = FALSE,
+  fixed = FALSE, useBytes = FALSE)
 }
 \arguments{
 \item{text}{Text to search}

man/textAreaInputAlt.Rd

@@ -4,9 +4,9 @@
 \alias{textAreaInputAlt}
 \title{Modified Text Area Input}
 \usage{
-textAreaInputAlt(inputId, label, value = "", width = NULL, height = NULL,
-  cols = NULL, rows = NULL, placeholder = NULL, resize = NULL,
-  is_code = TRUE)
+textAreaInputAlt(inputId, label, value = "", width = NULL,
+  height = NULL, cols = NULL, rows = NULL, placeholder = NULL,
+  resize = NULL, is_code = TRUE)
 }
 \arguments{
 \item{inputId}{The \code{input} slot that will be used to access the value.}
@@ -48,3 +48,4 @@ code font style for the input text and with \code{autocomplete}, \code{autocorre
 \seealso{
 Other modified shiny inputs: \code{\link{textInputCode}}
 }
+\concept{modified shiny inputs}

man/textInputCode.Rd

@@ -28,3 +28,4 @@ font style for the input text and with \code{autocomplete}, \code{autocorrect},
 \seealso{
 Other modified shiny inputs: \code{\link{textAreaInputAlt}}
 }
+\concept{modified shiny inputs}

man/view_regex.Rd

@@ -5,7 +5,7 @@
 \title{View grouped regex results}
 \usage{
 view_regex(text, pattern, ..., render = TRUE, escape = render,
-  knitr = FALSE, exact = escape)
+  exact = escape, result_only = FALSE)
 }
 \arguments{
 \item{text}{Text to search}
@@ -28,14 +28,14 @@ view_regex(text, pattern, ..., render = TRUE, escape = render,
 
 \item{escape}{Escape HTML-related characters in \code{text}?}
 
-\item{knitr}{Print into knitr doc? If \code{TRUE}, marks text as \code{asis_output} and
-sets \code{render = FALSE} and \code{escape = TRUE}.}
-
 \item{exact}{Should the regex pattern be displayed as entered by the user
 into R console or source (default)? When \code{TRUE}, regex is displayed with
 the double \code{\\\\} required for escaping backslashes in R. When \code{FALSE},
 regex is displayed as interpreted by the regex engine (i.e. double \code{\\\\}
 as a single \code{\\}).}
+
+\item{result_only}{Should only the result be displayed? If \code{FALSE}, then
+the colorized regular expression is also displayed in the output.}
 }
 \description{
 View the result of the regular expression when applied to the given text.