Merge pull request #218 from atorus-research/217_small_typo

Closes #217 Fixing a small typo

.github/pull_request_template.md

@@ -23,7 +23,7 @@ _(descriptions of changes)_
 - [ ] Run `devtools::document()` so all `.Rd` files in the `man` folder and the `NAMESPACE` file in the project root are updated appropriately
 - [ ] Run `pkgdown::build_site()` and check that all affected examples are displayed correctly and that all new/updated functions occur on the "Reference" page.
 - [ ] Update NEWS.md if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
-- [ ] Make sure that the pacakge version in the NEWS.md and DESCRIPTION file is same. Don't worry about updating the version because it will be auto-updated using the `vbump.yaml` CI.
+- [ ] Make sure that the package version in the NEWS.md and DESCRIPTION file is same. Don't worry about updating the version because it will be auto-updated using the `vbump.yaml` CI.
 - [ ] Address any updates needed for vignettes and/or templates
 - [ ] Link the issue Development Panel so that it closes after successful merging.
 - [ ] Fix merge conflicts

R/data.R

@@ -95,7 +95,7 @@
 #'   \item{Purpose}{<chr> Purpose of the dataset}
 #'   \item{Key, Variables}{<chr> Join Key variables in the dataset}
 #'   \item{Repeating}{<chr> Indicates if the dataset is repeating}
-#'   \item{Reference Data}{<lgl> Regerence Data}
+#'   \item{Reference Data}{<lgl> Reference Data}
 #'   \item{Comment}{<chr> Additional comment}
 #' }
 "dataset_spec"

R/format.R

@@ -2,7 +2,7 @@
 #'
 #' Assigns a SAS format from a variable level metadata to a given data frame. If
 #' no format is found for a given variable, it is set as an empty character
-#' vector. This is stored in the format.sas attribute.
+#' vector. This is stored in the '`format.sas`' attribute.
 #'
 #' @inheritParams xportr_length
 #'
@@ -19,7 +19,7 @@
 #'   function.
 #'
 #'   2) Format Name - passed as the 'xportr.format_name' option.
-#'   Default: "format". Character values to update the 'format.sas' attribute of
+#'   Default: "format". Character values to update the '`format.sas`' attribute of
 #'   the column. This is passed to `haven::write` to note the format.
 #'
 #'   3) Variable Name - passed as the 'xportr.variable_name' option. Default:

R/order.R

@@ -39,8 +39,8 @@
 #'
 #'   3) Variable Order - passed as the 'xportr.order_name' option.
 #'   Default: "order". These values used to arrange the order of the variables.
-#'   If the values of order metadata are not numeric, they will be corsersed to
-#'   prevent alphabetical sorting of numberic values.
+#'   If the values of order metadata are not numeric, they will be coerced to
+#'   prevent alphabetical sorting of numeric values.
 #'
 #' @return Dataframe that has been re-ordered according to spec
 #'

R/type.R

@@ -5,15 +5,16 @@
 #' 'xportr.character_types' option is used to explicitly collapse the class of a
 #' column to character using `as.character`. Similarly, 'xportr.numeric_types'
 #' will collapse a column to a numeric type. If no type is passed for a
-#' variable and it isn't identifed as a timing variable, it is assumed to be numeric and coerced with `as.numeric`.
+#' variable and it isn't identified as a timing variable, it is assumed to be
+#' numeric and coerced with `as.numeric`.
 #'
 #' Certain care should be taken when using timing variables. R serializes dates
 #' based on a reference date of 01/01/1970 where XPT uses 01/01/1960. This can
 #' result in dates being 10 years off when outputting from R to XPT if you're
 #' using a date class. For this reason, `xportr` will try to determine what
 #' should happen with variables that appear to be used to denote time.
 #'
-#' For variables that end in DT, DTM, or, TM, if they are not explicitly noted
+#' For variables that end in `DT`, `DTM`, or, `TM`, if they are not explicitly noted
 #' in 'xportr.numeric_types' or 'xportr.character_types', they are coerced to
 #' numeric results.
 #'
@@ -37,7 +38,7 @@
 #'   function.
 #'
 #'   2) Format Name - passed as the 'xportr.format_name' option. Default:
-#'   "format". Character values to update the 'format.sas' attribute of the
+#'   "format". Character values to update the '`format.sas`' attribute of the
 #'   column. This is passed to `haven::write` to note the format.
 #'
 #'   3) Variable Name - passed as the 'xportr.variable_name' option. Default:
@@ -48,14 +49,14 @@
 #'   is used to note the XPT variable "type" options are numeric or character.
 #'
 #'   5) (Option only) Character Types - The list of classes that should be
-#'   explicitly coerced to a XPT Character type. Default: c( "character",
+#'   explicitly coerced to a XPT Character type. Default: `c( "character",
 #'   "char", "text", "date", "posixct", "posixt", "datetime", "time",
 #'   "partialdate", "partialtime", "partialdatetime", "incompletedatetime",
-#'   "durationdatetime", "intervaldatetime")
+#'   "durationdatetime", "intervaldatetime")`
 #'
 #'   6) (Option only) Numeric Types - The list of classes that should be
-#'   explicitly coerced to a XPT numeric type. Default: c("integer", "numeric",
-#'   "num", "float")
+#'   explicitly coerced to a XPT numeric type. Default: `c("integer", "numeric",
+#'   "num", "float")`
 #'
 #' @return Returns the modified table.
 #' @export

R/xportr-package.R

@@ -4,7 +4,7 @@
 #' CDISC complaint data sets in R, to XPT version 5 files. It was designed with
 #' options in mind to allow for flexible setting of options while allowing
 #' projects and system administrators to set sensible defaults for their
-#' orginziations workflows. Below are a list of options that can be set to
+#' organizations workflows. Below are a list of options that can be set to
 #' customize how `xportr` works in your environment.
 #'
 #' @section xportr options:
@@ -64,15 +64,15 @@
 #'   }
 #'   \item{
 #'   xportr.character_types - The default character vector used to explicitly
-#'   coerce R classes to character XPT types. Default: c("character", "char",
+#'   coerce R classes to character XPT types. Default: `c("character", "char",
 #'   "text", "date", "posixct", "posixt", "datetime", "time", "partialdate",
 #'   "partialtime", "partialdatetime", "incompletedatetime", "durationdatetime",
-#'   "intervaldatetime")
+#'   "intervaldatetime")`
 #'   }
 #'   \item{
 #'   xportr.numeric_types - The default character vector used to explicitly
-#'   coerce R classes to numeric XPT types. Default: c("integer", "numeric",
-#'   "num", "float")
+#'   coerce R classes to numeric XPT types. Default: `c("integer", "numeric",
+#'   "num", "float")`
 #'   }
 #' }
 #'