ore.search {ore} | R Documentation |
Search a character vector for one or more matches to an Oniguruma-compatible
regular expression. The result is of class "orematches"
, for which
printing and indexing methods are available.
ore.search(regex, text, all = FALSE, start = 1L, simplify = TRUE, incremental = !all) is.orematch(x) ## S3 method for class 'orematch' x[j, k, ...] ## S3 method for class 'orematches' x[i, j, k, ...] ## S3 method for class 'orematch' print(x, lines = NULL, context = NULL, width = NULL, ...) ## S3 method for class 'orematches' print(x, ...)
regex |
A single character string or object of class |
text |
A vector of strings to match against, or the result of a call to
|
all |
If |
start |
An optional vector of offsets (in characters) at which to start
searching. Will be recycled to the length of |
simplify |
If |
incremental |
If |
x |
An R object. |
j |
For indexing, the match number. |
k |
For indexing, the group number. |
... |
Ignored. |
i |
For indexing into an |
lines |
The maximum number of lines to print. If |
context |
The number of characters of context to include either side
of each match. If |
width |
The number of characters in each line of printed output. If
|
For ore.search
, an "orematch"
object, or a list of
the same, each with elements
text |
A copy of the |
nMatches |
The number of matches found. |
offsets |
The offsets (in characters) of each match. |
byteOffsets |
The offsets (in bytes) of each match. |
lengths |
The lengths (in characters) of each match. |
byteLengths |
The lengths (in bytes) of each match. |
matches |
The matched substrings. |
groups |
Equivalent metadata for each parenthesised subgroup in
|
For is.orematch
, a logical vector indicating whether the specified
object has class "orematch"
. For extraction with one index, a
vector of matched substrings. For extraction with two indices, a vector
or matrix of substrings corresponding to captured groups.
Only named *or* unnamed groups will currently be captured, not both. If there are named groups in the pattern, then unnamed groups will be ignored.
By default the print
method uses the crayon
package (if it is
available) to determine whether or not the R terminal supports colour.
Alternatively, colour printing may be forced or disabled by setting the
"ore.colour"
(or "ore.color"
) option to a logical value.
ore
for creating regex objects; matches
and groups
for an alternative to indexing for extracting
matching substrings.
# Pick out pairs of consecutive word characters match <- ore.search("(\\w)(\\w)", "This is a test", all=TRUE) # Find the second matched substring ("is", from "This") match[2] # Find the content of the second group in the second match ("s") match[2,2]