From dbb600810749237e63fb1a07b6a166d3f744e610 Mon Sep 17 00:00:00 2001 From: matthias-da Date: Mon, 4 Dec 2023 17:34:18 +0100 Subject: [PATCH] help files for cran checks --- R/aux_functions.r | 8 ++++---- R/dRisk.R | 4 ++-- man/dRisk.Rd | 4 ++-- man/extractManipData.Rd | 8 ++++---- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/R/aux_functions.r b/R/aux_functions.r index 2d6d33a9..2cf5708c 100644 --- a/R/aux_functions.r +++ b/R/aux_functions.r @@ -411,11 +411,11 @@ setMethod(f="calcRisksX", signature=c("sdcMicroObj"), definition=function(obj, . #' @param randomizeRecords (logical) specifies, if the output records should be randomized. The following #' options are possible: #' \describe{ -#' \item {'no'}{default, no randomization takes place} -#' \item {'simple'}{records are just randomly swapped.} -#' \item {'byHH'}{if slot 'hhId' is not \code{NULL}, the clusters defined by this variable are randomized across the dataset. If +#' \item{'no'}{default, no randomization takes place} +#' \item{'simple'}{records are just randomly swapped.} +#' \item{'byHH'}{if slot 'hhId' is not \code{NULL}, the clusters defined by this variable are randomized across the dataset. If #' slot 'hhId' is \code{NULL}, the records or the dataset are randomly changed.} -#' \item {'withinHH'}{if slot 'hhId' is not \code{NULL}, the clusters defined by this variable are randomized across the dataset and +#' \item{'withinHH'}{if slot 'hhId' is not \code{NULL}, the clusters defined by this variable are randomized across the dataset and #' additionally, the order of records within the clusters are also randomly changed. If slot 'hhId' is \code{NULL}, the records or the dataset are #' randomly changed.}} #' @return a \code{data.frame} containing the anonymized data set diff --git a/R/dRisk.R b/R/dRisk.R index f75ca59e..1376503d 100644 --- a/R/dRisk.R +++ b/R/dRisk.R @@ -12,8 +12,8 @@ #' @param obj a \code{data.frame} or object of class \code{\link{sdcMicroObj-class}} #' @param ... possible arguments are: #' \describe{ -#' \item {\code{xm}: }{perturbed data} -#' \item {\code{k}: }{percentage of the standard deviation}} +#' \item{\code{xm}:}{perturbed data} +#' \item{\code{k}:}{percentage of the standard deviation}} #' @return The disclosure risk or/and the modified \code{\link{sdcMicroObj-class}} #' @author Matthias Templ #' @seealso \code{\link{dUtility}} diff --git a/man/dRisk.Rd b/man/dRisk.Rd index 91ee9aa8..1336b5f5 100644 --- a/man/dRisk.Rd +++ b/man/dRisk.Rd @@ -11,8 +11,8 @@ dRisk(obj, ...) \item{...}{possible arguments are: \describe{ -\item {\code{xm}: }{perturbed data} -\item {\code{k}: }{percentage of the standard deviation}}} +\item{\code{xm}:}{perturbed data} +\item{\code{k}:}{percentage of the standard deviation}}} } \value{ The disclosure risk or/and the modified \code{\link{sdcMicroObj-class}} diff --git a/man/extractManipData.Rd b/man/extractManipData.Rd index 59a3d550..02979a7b 100644 --- a/man/extractManipData.Rd +++ b/man/extractManipData.Rd @@ -35,11 +35,11 @@ the unchanged original variables} \item{randomizeRecords}{(logical) specifies, if the output records should be randomized. The following options are possible: \describe{ -\item {'no'}{default, no randomization takes place} -\item {'simple'}{records are just randomly swapped.} -\item {'byHH'}{if slot 'hhId' is not \code{NULL}, the clusters defined by this variable are randomized across the dataset. If +\item{'no'}{default, no randomization takes place} +\item{'simple'}{records are just randomly swapped.} +\item{'byHH'}{if slot 'hhId' is not \code{NULL}, the clusters defined by this variable are randomized across the dataset. If slot 'hhId' is \code{NULL}, the records or the dataset are randomly changed.} -\item {'withinHH'}{if slot 'hhId' is not \code{NULL}, the clusters defined by this variable are randomized across the dataset and +\item{'withinHH'}{if slot 'hhId' is not \code{NULL}, the clusters defined by this variable are randomized across the dataset and additionally, the order of records within the clusters are also randomly changed. If slot 'hhId' is \code{NULL}, the records or the dataset are randomly changed.}}} }