diff --git a/R/check_text.R b/R/check_text.R index 27e7ce9..9874e1d 100644 --- a/R/check_text.R +++ b/R/check_text.R @@ -18,7 +18,6 @@ #' @param n The number of affected elements to print out (the rest are truncated). #' @param \ldots ignored. #' @return Returns a list with the following potential text faults report:\cr -#' \itemize{ #' \item{contraction}{- Text elements that contain contractions} #' \item{date}{- Text elements that contain dates} #' \item{digit}{- Text elements that contain digits/numbers} @@ -42,7 +41,7 @@ #' \item{tag}{- Text elements that contain Twitter style handle tags (e.g., @@trinker)} #' \item{time}{- Text elements that contain timestamps} #' \item{url}{- Text elements that contain URLs} -#' } +#' #' @note The output is a list containing meta checks and elemental checks #' but prints as a pretty formatted output with potential problem elements, the #' accompanying text, and possible suggestions to fix the text. diff --git a/R/replace_html.R b/R/replace_html.R index 5399894..67a3d98 100644 --- a/R/replace_html.R +++ b/R/replace_html.R @@ -42,7 +42,7 @@ #' } #' #' @param x The text variable. -#' @param symbol logical. If code{TRUE} the symbols are retained with appropriate +#' @param symbol logical. If \code{TRUE} the symbols are retained with appropriate #' replacements. If \code{FALSE} they are removed. #' @param \ldots Ignored. #' @return Returns a vector with HTML markup replaced. diff --git a/man/check_text.Rd b/man/check_text.Rd index 0eeccc4..a930916 100644 --- a/man/check_text.Rd +++ b/man/check_text.Rd @@ -27,7 +27,6 @@ meta checks).} } \value{ Returns a list with the following potential text faults report:\cr -\itemize{ \item{contraction}{- Text elements that contain contractions} \item{date}{- Text elements that contain dates} \item{digit}{- Text elements that contain digits/numbers} @@ -52,7 +51,6 @@ Returns a list with the following potential text faults report:\cr \item{time}{- Text elements that contain timestamps} \item{url}{- Text elements that contain URLs} } -} \description{ \code{check_text} - Uncleaned text may result in errors, warnings, and incorrect results in subsequent analysis. \code{check_text} checks text for diff --git a/man/replace_html.Rd b/man/replace_html.Rd index 3984120..340398b 100644 --- a/man/replace_html.Rd +++ b/man/replace_html.Rd @@ -9,7 +9,7 @@ replace_html(x, symbol = TRUE, ...) \arguments{ \item{x}{The text variable.} -\item{symbol}{logical. If code{TRUE} the symbols are retained with appropriate +\item{symbol}{logical. If \code{TRUE} the symbols are retained with appropriate replacements. If \code{FALSE} they are removed.} \item{\ldots}{Ignored.}