diff --git a/R/force_num.R b/R/force_num.R index a92fb9f..ece9c6c 100644 --- a/R/force_num.R +++ b/R/force_num.R @@ -2,7 +2,7 @@ #' #' @description Coerces a vector into a numeric vector and automatically silences `NAs introduced by coercion` warning. Useful for cases where non-numbers are known to exist in vector and their coercion to NA is expected / unremarkable. Essentially just a way of forcing this coercion more succinctly than wrapping `as.numeric` in `suppressWarnings`. #' -#' @param x (non-numeric) vector containing elements to be coereced into class numeric +#' @param x (non-numeric) vector containing elements to be coerced into class numeric #' #' @return (numeric) vector of numeric values #' @export diff --git a/R/rmd_export.R b/R/rmd_export.R index aa6e9cc..2042ee4 100644 --- a/R/rmd_export.R +++ b/R/rmd_export.R @@ -5,7 +5,7 @@ #' @param rmd (character) name and path to R markdown file to knit #' @param out_path (character) path to the knit file's destination (defaults to path returned by `getwd`) #' @param out_name (character) desired name for knit file (with or without file suffix) -#' @param out_type (character) either "html" or "pdf" depending on what YML entry you have in the `output: ` field of your R Markdown file +#' @param out_type (character) either "html" or "pdf" depending on what YAML entry you have in the `output: ` field of your R Markdown file #' @param drive_link (character) full URL of drive folder to upload the knit document #' #' @return No return value, called to knit R Markdown file diff --git a/R/tabularize_md.R b/R/tabularize_md.R index da7dd1d..0e04ba3 100644 --- a/R/tabularize_md.R +++ b/R/tabularize_md.R @@ -4,7 +4,7 @@ #' #' @param file (character/url connection) name and file path of markdown file to transform into a table or a connection object to a URL of a markdown file (see `?base::url` for more details) #' -#' @return (dataframe) table with one additional column than there are heading levels in the document (e.g., if first and second level headings are in the document, the resulting table will have three columns) and one row per line of non-heading content in the markdwon file. +#' @return (dataframe) table with one additional column than there are heading levels in the document (e.g., if first and second level headings are in the document, the resulting table will have three columns) and one row per line of non-heading content in the markdown file. #' #' @importFrom magrittr %>% #' @importFrom magrittr %<>% diff --git a/man/force_num.Rd b/man/force_num.Rd index e68a7ea..f4fe601 100644 --- a/man/force_num.Rd +++ b/man/force_num.Rd @@ -7,7 +7,7 @@ force_num(x = NULL) } \arguments{ -\item{x}{(non-numeric) vector containing elements to be coereced into class numeric} +\item{x}{(non-numeric) vector containing elements to be coerced into class numeric} } \value{ (numeric) vector of numeric values diff --git a/man/rmd_export.Rd b/man/rmd_export.Rd index 46c142c..d06dbd1 100644 --- a/man/rmd_export.Rd +++ b/man/rmd_export.Rd @@ -19,7 +19,7 @@ rmd_export( \item{out_name}{(character) desired name for knit file (with or without file suffix)} -\item{out_type}{(character) either "html" or "pdf" depending on what YML entry you have in the \verb{output: } field of your R Markdown file} +\item{out_type}{(character) either "html" or "pdf" depending on what YAML entry you have in the \verb{output: } field of your R Markdown file} \item{drive_link}{(character) full URL of drive folder to upload the knit document} } diff --git a/man/tabularize_md.Rd b/man/tabularize_md.Rd index f37ea76..3df5f79 100644 --- a/man/tabularize_md.Rd +++ b/man/tabularize_md.Rd @@ -10,7 +10,7 @@ tabularize_md(file = NULL) \item{file}{(character/url connection) name and file path of markdown file to transform into a table or a connection object to a URL of a markdown file (see \code{?base::url} for more details)} } \value{ -(dataframe) table with one additional column than there are heading levels in the document (e.g., if first and second level headings are in the document, the resulting table will have three columns) and one row per line of non-heading content in the markdwon file. +(dataframe) table with one additional column than there are heading levels in the document (e.g., if first and second level headings are in the document, the resulting table will have three columns) and one row per line of non-heading content in the markdown file. } \description{ Accepts one markdown file (i.e., "md" file extension) and returns its content as a table. Nested heading structure in markdown file--as defined by hashtags / pounds signs (#)--is identified and preserved as columns in the resulting tabular format. Each line of non-heading content in the file is preserved in the right-most column of one row of the table. diff --git a/vignettes/supportR.Rmd b/vignettes/supportR.Rmd index 9351b5e..29d5975 100644 --- a/vignettes/supportR.Rmd +++ b/vignettes/supportR.Rmd @@ -49,7 +49,7 @@ supportR::summary_table(data = penguins, groups = c("species", "island"), response = "bill_length_mm", drop_na = T) ``` -The `safe_rename` function allows--perhaps predicatably--"safe" renaming of column names in a given data object. The 'bad' column names and corresponding 'good' names must be specified. The order of entries in the two vectors must match (i.e., the first bad name will be replaced with the first good name), but that order need not match the order in which they occur in the data! +The `safe_rename` function allows--perhaps predictably--"safe" renaming of column names in a given data object. The 'bad' column names and corresponding 'good' names must be specified. The order of entries in the two vectors must match (i.e., the first bad name will be replaced with the first good name), but that order need not match the order in which they occur in the data! ```{r safe-rename} # Make a dataframe to demonstrate