mirror of
https://github.com/msberends/AMR.git
synced 2025-12-13 23:50:20 +01:00
(v0.8.0.9036) complete documentation rewrite
This commit is contained in:
14
man/like.Rd
14
man/like.Rd
@@ -18,12 +18,12 @@ x \%like_case\% pattern
|
||||
\arguments{
|
||||
\item{x}{a character vector where matches are sought, or an
|
||||
object which can be coerced by \code{as.character} to a character
|
||||
vector. \link{Long vectors} are supported.}
|
||||
vector. \link[base]{Long vectors} are supported.}
|
||||
|
||||
\item{pattern}{character string containing a \link{regular expression}
|
||||
\item{pattern}{character string containing a \link[base]{regular expression}
|
||||
(or character string for \code{fixed = TRUE}) to be matched
|
||||
in the given character vector. Coerced by
|
||||
\code{\link{as.character}} to a character string if possible. If a
|
||||
\code{\link[base]{as.character}} to a character string if possible. If a
|
||||
character vector of length 2 or more is supplied, the first element
|
||||
is used with a warning. Missing values are allowed except for
|
||||
\code{regexpr} and \code{gregexpr}.}
|
||||
@@ -32,13 +32,13 @@ x \%like_case\% pattern
|
||||
sensitive} and if \code{TRUE}, case is ignored during matching.}
|
||||
}
|
||||
\value{
|
||||
A \code{logical} vector
|
||||
A \code{\link{logical}} vector
|
||||
}
|
||||
\description{
|
||||
Convenient wrapper around \code{\link[base]{grep}} to match a pattern: \code{a \%like\% b}. It always returns a \code{logical} vector and is always case-insensitive (use \code{a \%like_case\% b} for case-sensitive matching). Also, \code{pattern} (\code{b}) can be as long as \code{x} (\code{a}) to compare items of each index in both vectors, or can both have the same length to iterate over all cases.
|
||||
Convenient wrapper around \code{\link[base:grep]{base::grep()}} to match a pattern: \code{a \%like\% b}. It always returns a \code{\link{logical}} vector and is always case-insensitive (use \code{a \%like_case\% b} for case-sensitive matching). Also, \code{pattern} (\emph{b}) can be as long as \code{x} (\emph{a}) to compare items of each index in both vectors, or can both have the same length to iterate over all cases.
|
||||
}
|
||||
\details{
|
||||
Using RStudio? This function can also be inserted from the Addins menu and can have its own Keyboard Shortcut like Ctrl+Shift+L or Cmd+Shift+L (see Tools > Modify Keyboard Shortcuts...).
|
||||
Using RStudio? This function can also be inserted from the Addins menu and can have its own Keyboard Shortcut like \code{Ctrl+Shift+L} or \code{Cmd+Shift+L} (see \code{Tools} > \verb{Modify Keyboard Shortcuts...}).
|
||||
}
|
||||
\section{Read more on our website!}{
|
||||
|
||||
@@ -67,5 +67,5 @@ example_isolates \%>\%
|
||||
freq(mo_fullname(mo))
|
||||
}
|
||||
\seealso{
|
||||
\code{\link[base]{grep}}
|
||||
\code{\link[base:grep]{base::grep()}}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user