| @@ -50,4 +50,4 @@ Suggests: | |||
| Encoding: UTF-8 | |||
| LazyData: true | |||
| Roxygen: list(markdown = TRUE) | |||
| RoxygenNote: 6.1.0 | |||
| RoxygenNote: 7.1.0 | |||
| @@ -4,8 +4,11 @@ | |||
| \alias{check_version} | |||
| \title{Check if an updated version is available} | |||
| \usage{ | |||
| check_version(gh_user = "gadenbuie", gh_repo = "regexplain", | |||
| this_version = packageVersion("regexplain")) | |||
| check_version( | |||
| gh_user = "gadenbuie", | |||
| gh_repo = "regexplain", | |||
| this_version = packageVersion("regexplain") | |||
| ) | |||
| } | |||
| \arguments{ | |||
| \item{gh_user}{GitHub user account} | |||
| @@ -4,8 +4,15 @@ | |||
| \alias{regex} | |||
| \title{Extract matched groups from regexp} | |||
| \usage{ | |||
| regex(text, pattern, ignore.case = FALSE, perl = FALSE, | |||
| fixed = FALSE, useBytes = FALSE, global = TRUE) | |||
| regex( | |||
| text, | |||
| pattern, | |||
| ignore.case = FALSE, | |||
| perl = FALSE, | |||
| fixed = FALSE, | |||
| useBytes = FALSE, | |||
| global = TRUE | |||
| ) | |||
| } | |||
| \arguments{ | |||
| \item{text}{Text to search} | |||
| @@ -8,8 +8,11 @@ | |||
| \usage{ | |||
| regexplain_file(pattern = NULL, start_page = "RegEx") | |||
| regexplain_gadget(text = NULL, pattern = NULL, start_page = if | |||
| (is.null(text)) "Text" else "RegEx") | |||
| regexplain_gadget( | |||
| text = NULL, | |||
| pattern = NULL, | |||
| start_page = if (is.null(text)) "Text" else "RegEx" | |||
| ) | |||
| regexplain_web(text = NULL, pattern = NULL, start_page = "Text", ...) | |||
| } | |||
| @@ -21,30 +24,33 @@ regexplain_web(text = NULL, pattern = NULL, start_page = "Text", ...) | |||
| \item{text}{Text to explore in gadget (editable using interface)} | |||
| \item{...}{Arguments passed on to \code{shiny::shinyApp} | |||
| \describe{ | |||
| \item{ui}{The UI definition of the app (for example, a call to | |||
| \item{...}{ | |||
| Arguments passed on to \code{\link[shiny:shinyApp]{shiny::shinyApp}} | |||
| \describe{ | |||
| \item{\code{ui}}{The UI definition of the app (for example, a call to | |||
| \code{fluidPage()} with nested controls)} | |||
| \item{server}{A server function} | |||
| \item{onStart}{A function that will be called before the app is actually run. | |||
| \item{\code{server}}{A function with three parameters: \code{input}, \code{output}, and | |||
| \code{session}. The function is called once for each session ensuring that each | |||
| app is independent.} | |||
| \item{\code{onStart}}{A function that will be called before the app is actually run. | |||
| This is only needed for \code{shinyAppObj}, since in the \code{shinyAppDir} | |||
| case, a \code{global.R} file can be used for this purpose.} | |||
| \item{options}{Named options that should be passed to the \code{runApp} call | |||
| \item{\code{options}}{Named options that should be passed to the \code{runApp} call | |||
| (these can be any of the following: "port", "launch.browser", "host", "quiet", | |||
| "display.mode" and "test.mode"). You can also specify \code{width} and | |||
| \code{height} parameters which provide a hint to the embedding environment | |||
| about the ideal height/width for the app.} | |||
| \item{uiPattern}{A regular expression that will be applied to each \code{GET} | |||
| \item{\code{uiPattern}}{A regular expression that will be applied to each \code{GET} | |||
| request to determine whether the \code{ui} should be used to handle the | |||
| request. Note that the entire request path must match the regular | |||
| expression in order for the match to be considered successful.} | |||
| \item{enableBookmarking}{Can be one of \code{"url"}, \code{"server"}, or | |||
| \item{\code{enableBookmarking}}{Can be one of \code{"url"}, \code{"server"}, or | |||
| \code{"disable"}. This is equivalent to calling the | |||
| \code{\link{enableBookmarking}()} function just before calling | |||
| \code{\link[shiny:enableBookmarking]{enableBookmarking()}} function just before calling | |||
| \code{shinyApp()}. With the default value (\code{NULL}), the app will | |||
| respect the setting from any previous calls to \code{enableBookmarking()}. | |||
| See \code{\link{enableBookmarking}} for more information.} | |||
| }} | |||
| See \code{\link[shiny:enableBookmarking]{enableBookmarking()}} for more information.} | |||
| }} | |||
| } | |||
| \description{ | |||
| The function behind the RegExplain Selection and RegExplain File | |||
| @@ -4,9 +4,18 @@ | |||
| \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.} | |||
| @@ -16,27 +25,28 @@ textAreaInputAlt(inputId, label, value = "", width = NULL, | |||
| \item{value}{Initial value.} | |||
| \item{width}{The width of the input, e.g. \code{'400px'}, or \code{'100\%'}; | |||
| see \code{\link{validateCssUnit}}.} | |||
| see \code{\link[shiny:validateCssUnit]{validateCssUnit()}}.} | |||
| \item{height}{The height of the input, e.g. \code{'400px'}, or | |||
| \code{'100\%'}; see \code{\link{validateCssUnit}}.} | |||
| \item{height}{The height of the input, e.g. \code{'400px'}, or \code{'100\%'}; see | |||
| \code{\link[shiny:validateCssUnit]{validateCssUnit()}}.} | |||
| \item{cols}{Value of the visible character columns of the input, e.g. | |||
| \code{80}. If used with \code{width}, \code{width} will take precedence in | |||
| the browser's rendering.} | |||
| \item{cols}{Value of the visible character columns of the input, e.g. \code{80}. | |||
| This argument will only take effect if there is not a CSS \code{width} rule | |||
| defined for this element; such a rule could come from the \code{width} argument | |||
| of this function or from a containing page layout such as | |||
| \code{\link[shiny:fluidPage]{fluidPage()}}.} | |||
| \item{rows}{The value of the visible character rows of the input, e.g. | |||
| \code{6}. If used with \code{height}, \code{height} will take precedence in | |||
| the browser's rendering.} | |||
| \item{rows}{The value of the visible character rows of the input, e.g. \code{6}. | |||
| If the \code{height} argument is specified, \code{height} will take precedence in the | |||
| browser's rendering.} | |||
| \item{placeholder}{A character string giving the user a hint as to what can | |||
| be entered into the control. Internet Explorer 8 and 9 do not support this | |||
| option.} | |||
| \item{resize}{Which directions the textarea box can be resized. Can be one of | |||
| \code{"both"}, \code{"none"}, \code{"vertical"}, and \code{"horizontal"}. | |||
| The default, \code{NULL}, will use the client browser's default setting for | |||
| resizing textareas.} | |||
| \code{"both"}, \code{"none"}, \code{"vertical"}, and \code{"horizontal"}. The default, \code{NULL}, | |||
| will use the client browser's default setting for resizing textareas.} | |||
| \item{is_code}{Should the text input be considered verbatim code input?} | |||
| } | |||
| @@ -46,6 +56,7 @@ code font style for the input text and with \code{autocomplete}, \code{autocorre | |||
| \code{autocapitalize} and \code{spellcheck} set to \code{off} or \code{false}. | |||
| } | |||
| \seealso{ | |||
| Other modified shiny inputs: \code{\link{textInputCode}} | |||
| Other modified shiny inputs: | |||
| \code{\link{textInputCode}()} | |||
| } | |||
| \concept{modified shiny inputs} | |||
| @@ -4,8 +4,14 @@ | |||
| \alias{textInputCode} | |||
| \title{Modified Text Input} | |||
| \usage{ | |||
| textInputCode(inputId, label, value = "", width = NULL, | |||
| placeholder = NULL, ...) | |||
| textInputCode( | |||
| inputId, | |||
| label, | |||
| value = "", | |||
| width = NULL, | |||
| placeholder = NULL, | |||
| ... | |||
| ) | |||
| } | |||
| \arguments{ | |||
| \item{inputId}{The \code{input} slot that will be used to access the value.} | |||
| @@ -28,6 +34,7 @@ font style for the input text and with \code{autocomplete}, \code{autocorrect}, | |||
| \code{autocapitalize} and \code{spellcheck} set to \code{off} or \code{false}. | |||
| } | |||
| \seealso{ | |||
| Other modified shiny inputs: \code{\link{textAreaInputAlt}} | |||
| Other modified shiny inputs: | |||
| \code{\link{textAreaInputAlt}()} | |||
| } | |||
| \concept{modified shiny inputs} | |||
| @@ -4,25 +4,33 @@ | |||
| \alias{view_regex} | |||
| \title{View grouped regex results} | |||
| \usage{ | |||
| view_regex(text, pattern, ..., render = TRUE, escape = render, | |||
| exact = escape, result_only = FALSE) | |||
| view_regex( | |||
| text, | |||
| pattern, | |||
| ..., | |||
| render = TRUE, | |||
| escape = render, | |||
| exact = escape, | |||
| result_only = FALSE | |||
| ) | |||
| } | |||
| \arguments{ | |||
| \item{text}{Text to search} | |||
| \item{pattern}{Regex pattern to look for} | |||
| \item{...}{Arguments passed on to \code{base::regexec} | |||
| \describe{ | |||
| \item{ignore.case}{if \code{FALSE}, the pattern matching is \emph{case | |||
| \item{...}{ | |||
| Arguments passed on to \code{\link[base:regexec]{base::regexec}} | |||
| \describe{ | |||
| \item{\code{ignore.case}}{if \code{FALSE}, the pattern matching is \emph{case | |||
| sensitive} and if \code{TRUE}, case is ignored during matching.} | |||
| \item{perl}{logical. Should Perl-compatible regexps be used?} | |||
| \item{fixed}{logical. If \code{TRUE}, \code{pattern} is a string to be | |||
| \item{\code{perl}}{logical. Should Perl-compatible regexps be used?} | |||
| \item{\code{fixed}}{logical. If \code{TRUE}, \code{pattern} is a string to be | |||
| matched as is. Overrides all conflicting arguments.} | |||
| \item{useBytes}{logical. If \code{TRUE} the matching is done | |||
| \item{\code{useBytes}}{logical. If \code{TRUE} the matching is done | |||
| byte-by-byte rather than character-by-character. See | |||
| \sQuote{Details}.} | |||
| }} | |||
| }} | |||
| \item{render}{Render results to an HTML doc and open in RStudio viewer?} | |||
| @@ -30,9 +38,9 @@ view_regex(text, pattern, ..., render = TRUE, escape = render, | |||
| \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{\\}).} | |||
| the double \verb{\\\\\\\\} required for escaping backslashes in R. When \code{FALSE}, | |||
| regex is displayed as interpreted by the regex engine (i.e. double \verb{\\\\\\\\} | |||
| as a single \verb{\\\\}).} | |||
| \item{result_only}{Should only the result be displayed? If \code{FALSE}, then | |||
| the colorized regular expression is also displayed in the output.} | |||
| @@ -13,9 +13,9 @@ wrap_regex(pattern, escape = TRUE, exact = 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{\\}).} | |||
| the double \verb{\\\\\\\\} required for escaping backslashes in R. When \code{FALSE}, | |||
| regex is displayed as interpreted by the regex engine (i.e. double \verb{\\\\\\\\} | |||
| as a single \verb{\\\\}).} | |||
| } | |||
| \description{ | |||
| Wraps capture groups in regex pattern in span tags to colorize with CSS | |||
| @@ -13,9 +13,9 @@ wrap_result(x, escape = FALSE, exact = FALSE) | |||
| \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{\\}).} | |||
| the double \verb{\\\\\\\\} required for escaping backslashes in R. When \code{FALSE}, | |||
| regex is displayed as interpreted by the regex engine (i.e. double \verb{\\\\\\\\} | |||
| as a single \verb{\\\\}).} | |||
| } | |||
| \description{ | |||
| Wrap matches in HTML span tags to colorize via CSS | |||