README.md

In jpmckeown/regexcite: Make Regular Expressions More Exciting

regexcite

The goal of regexcite is to provide convenience functions to make some common tasks with string manipulation and regular expressions a bit easier. Imports: stringr

Installation

You can install the development version of regexcite from GitHub with:

# install.packages("devtools")
devtools::install_github("jpmckeown/regexcite")

Example

This is a basic example which shows you how to solve a common problem:

## basic example code
(x <- "alfa,bravo,charlie,delta")
#> [1] "alfa,bravo,charlie,delta"
strsplit(x, split = ",")
#> [[1]]
#> [1] "alfa"    "bravo"   "charlie" "delta"
stringr::str_split(x, pattern = ",")
#> [[1]]
#> [1] "alfa"    "bravo"   "charlie" "delta"

Notice how the return value is a list of length one, where the first element holds the character vector of parts. Often the shape of this output is inconvenient, i.e. we want the un-listed version.

That’s exactly what regexcite::str_split_one() does.

library(regexcite)
str_split_1(x, pattern = ",")
#> [1] "alfa"    "bravo"   "charlie" "delta"

Use str_split_one() when the input is known to be a single string. For safety, it will error if its input has length greater than one.

str_split_one() is built on stringr::str_split(), so you can use its n argument and stringr’s general interface for describing the pattern to be matched.

You’ll still need to render README.Rmd regularly, to keep README.md up-to-date. devtools::build_readme() is handy for this. You could also use GitHub Actions to re-render README.Rmd every time you push. An example workflow can be found here: https://github.com/r-lib/actions/tree/v1/examples.

You can also embed plots, for example:

#> [1] "alfa"                "bravo,charlie,delta"
#> [1] "192" "168" "0"   "1"

In that case, don’t forget to commit and push the resulting figure files, so they display on GitHub and CRAN.

jpmckeown/regexcite documentation built on Jan. 1, 2022, 12:15 a.m.