Skip to content

Commit e8bec70

Browse files
beckymausthadley
authored andcommitted
Updated README and str_view() docs to advertise the RegExplain (#272)
Fixes #255
1 parent 4b7a181 commit e8bec70

File tree

5 files changed

+36
-7
lines changed

5 files changed

+36
-7
lines changed

R/view.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#' View HTML rendering of regular expression match.
22
#'
33
#' `str_view` shows the first match; `str_view_all` shows all
4-
#' the matches.
4+
#' the matches. To build regular expressions interactively, check out the
5+
#' [RegExplain RStudio addin](https://www.garrickadenbuie.com/project/regexplain/).
56
#'
67
#' @inheritParams str_detect
78
#' @param match If `TRUE`, shows only strings that match the pattern.

README.Rmd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,16 @@ As well as regular expressions (the default), there are three other pattern matc
111111
* `coll()`: match human letters
112112
* `boundary()`: match boundaries
113113
114+
## RStudio Addin
115+
116+
The [RegExplain RStudio addin](https://www.garrickadenbuie.com/project/regexplain/) provides a friendly interface for working with regular expressions and functions from stringr. This addin allows you to interactively build your regexp, check the output of common string matching functions, consult the interactive help pages, or use the included resources to learn regular expressions.
117+
118+
This addin can easily be installed with devtools:
119+
120+
```r
121+
# install.packages("devtools")
122+
devtools::install_github("gadenbuie/regexplain")
123+
```
114124

115125
## Compared to base R
116126

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,23 @@ pattern matching engines:
162162
- `coll()`: match human letters
163163
- `boundary()`: match boundaries
164164

165+
## RStudio Addin
166+
167+
The [RegExplain RStudio
168+
addin](https://www.garrickadenbuie.com/project/regexplain/) provides a
169+
friendly interface for working with regular expressions and functions
170+
from stringr. This addin allows you to interactively build your regexp,
171+
check the output of common string matching functions, consult the
172+
interactive help pages, or use the included resources to learn regular
173+
expressions.
174+
175+
This addin can easily be installed with devtools:
176+
177+
``` r
178+
# install.packages("devtools")
179+
devtools::install_github("gadenbuie/regexplain")
180+
```
181+
165182
## Compared to base R
166183

167184
R provides a solid set of string operations, but because they have grown

man/str_view.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/stringr-package.Rd

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)