addins and small improvements to microorganisms dataset

man/like.Rd

@@ -1,13 +1,15 @@
 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/misc.R
+% Please edit documentation in R/like.R
 \name{like}
 \alias{like}
 \alias{\%like\%}
 \title{Pattern Matching}
 \source{
-Inherited from the \href{https://github.com/Rdatatable/data.table/blob/master/R/like.R}{\code{like} function from the \code{data.table} package}, but made it case insensitive at default.
+Idea from the \href{https://github.com/Rdatatable/data.table/blob/master/R/like.R}{\code{like} function from the \code{data.table} package}, but made it case insensitive at default and let it support multiple patterns.
 }
 \usage{
+like(x, pattern)
+
 x \%like\% pattern
 }
 \arguments{
@@ -27,14 +29,33 @@ x \%like\% pattern
 A \code{logical} vector
 }
 \description{
-Convenience function to compare a vector with a pattern, like \code{\link[base]{grep}}. It always returns a \code{logical} vector and is always case-insensitive.
+Convenient wrapper around \code{\link[base]{grepl}} to match a pattern: \code{a \%like\% b}. It always returns a \code{logical} vector and is always case-insensitive. Also, \code{pattern} (\code{b}) can be as long as \code{x} (\code{a}) to compare items of each index in both vectors.
+}
+\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...).
 }
 \examples{
+# simple test
+a <- "This is a test"
+b <- "TEST"
+a \%like\% b
+#> TRUE
+b \%like\% a
+#> FALSE
+
+# also supports multiple patterns, length must be equal to x
+a <- c("Test case", "Something different", "Yet another thing")
+b <- c("case", "diff", "yet")
+a \%like\% b
+#> TRUE TRUE TRUE
+
+# get frequencies of bacteria whose name start with 'Ent' or 'ent'
 library(dplyr)
-# get unique occurences of bacteria whose name start with 'Ent'
 septic_patients \%>\%
   left_join_microorganisms() \%>\%
-  filter(fullname \%like\% '^Ent') \%>\%
-  pull(fullname) \%>\%
-  unique()
+  filter(genus \%like\% '^ent') \%>\%
+  freq(genus, species)
+}
+\seealso{
+\code{\link[base]{grep}}
 }

man/p.symbol.Rd

@@ -15,5 +15,5 @@ p.symbol(p, emptychar = " ")
 Text
 }
 \description{
-Return the symbol related to the p value: 0 '***' 0.001 '**' 0.01 '*' 0.05 '.' 0.1 ' ' 1
+Return the symbol related to the p value: 0 '***' 0.001 '**' 0.01 '*' 0.05 '.' 0.1 ' ' 1. Values above \code{p = 1} will return \code{NA}.
 }