Minor additional cleanup

R/clean_names.R

@@ -23,9 +23,9 @@
 #' which is a character vector mapping all known mu or micro Unicode code points
 #' (characters) to "u".
 #'
-#' @param dat the input data.frame.
+#' @param dat The input `data.frame`.
 #' @inheritDotParams make_clean_names -string
-#' @return Returns the data.frame with clean names.
+#' @return A `data.frame` with clean names.
 #'
 #' @details `clean_names()` is intended to be used on `data.frames`
 #'   and `data.frame`-like objects. For this reason there are methods to

R/excel_dates.R

@@ -1,7 +1,7 @@
-#' @title Convert dates encoded as serial numbers to Date class.
+#' Convert dates encoded as serial numbers to Date class.
 #'
-#' @description Converts numbers like `42370` into date values like
-#' `2016-01-01`.
+#' @description 
+#' Converts numbers like `42370` into date values like `2016-01-01`.
 #'
 #' Defaults to the modern Excel date encoding system. However, Excel for Mac
 #' 2008 and earlier Mac versions of Excel used a different date system. To
@@ -14,11 +14,10 @@
 #' current timezone is available from `base::Sys.timezone()`.
 #'
 #' If your input data has a mix of Excel numeric dates and actual dates, see the
-#' more powerful functions `convert_to_date()` and `convert_to_datetime()`.
+#' more powerful functions [convert_to_date()] and `convert_to_datetime()`.
 #'
 #' @param date_num numeric vector of serial numbers to convert.
-#' @param date_system the date system, either `"modern"` or `"mac
-#'   pre-2011"`.
+#' @param date_system the date system, either `"modern"` or `"mac pre-2011"`.
 #' @param include_time Include the time (hours, minutes, seconds) in the output?
 #'   (See details)
 #' @param round_seconds Round the seconds to an integer (only has an effect when

R/get_one_to_one.R

@@ -1,6 +1,6 @@
 #' Find the list of columns that have a 1:1 mapping to each other
 #'
-#' @param dat A data.frame or similar object
+#' @param dat A `data.frame` or similar object
 #' @return A list with one element for each group of columns that map
 #'   identically to each other.
 #' @export

R/statistical_tests.R

@@ -7,9 +7,9 @@
 #'
 #' @param x a two-way tabyl, a numeric vector or a factor
 #' @param ... other parameters passed to [stats::chisq.test()]
-#' @return The result is the same as the one of stats::chisq.test. If `tabyl_results`
-#' is `TRUE`, the returned tables `observed`, `expected`, `residuals` and `stdres`
-#' are converted to tabyls.
+#' @return The result is the same as the one of `stats::chisq.test()`.
+#'   If `tabyl_results` is `TRUE`, the returned tables `observed`, `expected`,
+#'    `residuals` and `stdres` are converted to tabyls.
 #'
 #' @examples
 #' tab <- tabyl(mtcars, gear, cyl)

janitor.Rproj

@@ -16,3 +16,5 @@ BuildType: Package
 PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
 PackageRoxygenize: rd,collate,namespace
+
+SpellingDictionary: en_US