docs: clean up argument docs

R/anonymise.R

@@ -26,12 +26,12 @@
 #' rep <- c("Manager+", "Manager", "IC")
 #' unique(anonymise(sq_data$Layer), replacement = rep)
 #'
+#' @seealso jitter
 #' @export
 
 anonymise <- function(x,
                       scramble = FALSE,
-                      replacement = NULL,
-                      jitter = NULL){
+                      replacement = NULL){
 
   n_to_rep <- length(x)
   v_to_rep <- unique(x)
@@ -87,6 +87,7 @@ anonymize <- anonymise
 #'   )
 #' )
 #'
+#' @seealso anonymise
 #' @export
 
 jitter_metrics <- function(data, cols = NULL, ...){

man/anonymise.Rd

@@ -5,9 +5,9 @@
 \alias{anonymize}
 \title{Anonymise a categorical variable by replacing values}
 \usage{
-anonymise(x, scramble = FALSE, replacement = NULL, jitter = NULL)
+anonymise(x, scramble = FALSE, replacement = NULL)
 
-anonymize(x, scramble = FALSE, replacement = NULL, jitter = NULL)
+anonymize(x, scramble = FALSE, replacement = NULL)
 }
 \arguments{
 \item{x}{Character vector to be passed through.}
@@ -34,3 +34,6 @@ rep <- c("Manager+", "Manager", "IC")
 unique(anonymise(sq_data$Layer), replacement = rep)
 
 }
+\seealso{
+jitter
+}

man/jitter_metrics.Rd

@@ -29,3 +29,6 @@ head(
 )
 
 }
+\seealso{
+anonymise
+}