“��

R/GUIfunctions.R

@@ -569,11 +569,11 @@ importProblem <- function(path) {
 #'
 #' @param obj an object of class \code{\link{data.frame}} containing micro data
 #' @param type algorithm used to sample from original microdata. Currently supported choices are
-#' \itemize{
-#' \item \code{n_perc}{ the restricted microdata will be a \code{n-percent} sample of the original microdata.}
-#' \item \code{first_n}{ only the first \code{n} observations will be used.}
-#' \item \code{every_n}{ the restricted microdata set consists of every \code{n-th} record.}
-#' \item \code{size_n}{ a total of \code{n} observations will be randomly drawn.}
+#' \describe{
+#' \item{\code{n_perc}}{ the restricted microdata will be a \code{n-percent} sample of the original microdata.}
+#' \item{\code{first_n}}{ only the first \code{n} observations will be used.}
+#' \item{\code{every_n}}{ the restricted microdata set consists of every \code{n-th} record.}
+#' \item{\code{size_n}}{ a total of \code{n} observations will be randomly drawn.}
 #' }
 #' @param n numeric vector of length 1 specifying the specific parameter with respect to argument \code{type}.
 #' @return an object of class \code{\link{sdcMicroObj-class}} with modified slot \code{@origData}.

R/LocalRecProg.R

@@ -20,7 +20,7 @@
 #' @param lowMemory Slower algorithm with less memory consumption
 #' @param missingValue The output value for a suppressed value.
 #' @param ... see arguments below
-#' \itemize{
+#' \describe{
 #' \item{categorical}{Names of categorical variables}
 #' \item{numerical}{Names of numerical variables}}
 #' @return dataframe with original variables and the supressed variables

R/aux_functions.r

@@ -410,7 +410,7 @@ setMethod(f="calcRisksX", signature=c("sdcMicroObj"), definition=function(obj, .
 #' the unchanged original variables
 #' @param randomizeRecords (logical) specifies, if the output records should be randomized. The following
 #' options are possible:
-#' \itemize{
+#' \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

R/dRisk.R

@@ -11,7 +11,7 @@
 #' @name dRisk
 #' @param obj a \code{data.frame} or object of class \code{\link{sdcMicroObj-class}}
 #' @param ... possible arguments are:
-#' \itemize{
+#' \describe{
 #' \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}}

R/dataGen.r

@@ -9,7 +9,7 @@
 #' @docType methods
 #' @param obj an \code{\link{sdcMicroObj-class}}-object or a \code{data.frame}
 #' @param ... see possible arguments below
-#' \itemize{
+#' \describe{
 #' \item{n:}{ amount of observations for the generated data, defaults to 200}
 #' \item{use:}{ howto compute covariances in case of missing values, see also argument \code{use} in \code{\link{cov}}.
 #' The default choice is 'everything', other possible choices are 'all.obs', 'complete.obs', 'na.or.complete' or 'pairwise.complete.obs'.}}

R/globalRecode.R

@@ -10,7 +10,7 @@
 #' @param obj a numeric vector, a \code{data.frame} or an object of class
 #' \code{\link{sdcMicroObj-class}}
 #' @param ... see possible arguments below
-#' \itemize{
+#' \describe{
 #' \item{column: }{which keyVar should be changed. Character vector of length 1 specifying the variable name that
 #' should be recoded (required if \code{obj} is a \code{data.frame} or
 #' an object of class \code{\link{sdcMicroObj-class}}.}

R/indivRisk.R

@@ -12,7 +12,7 @@
 #' @param qual final correction factor
 #' @param survey TRUE, if we have survey data and FALSE if we deal with a population.
 #' @return
-#' \itemize{
+#' \describe{
 #' \item{rk: }{ base individual risk }
 #' \item{method: }{method}
 #' \item{qual: }{final correction factor}

R/localSuppression.R

@@ -30,7 +30,7 @@
 #' subsets by specifying k as a vector. If k has only one element, the same value
 #' of k will be used for all subgroups.
 #' @param ... see arguments below
-#' \itemize{
+#' \describe{
 #' \item{keyVars: }{names (or indices) of categorical key variables (for data-frame method)}
 #' \item{strataVars: }{name (or index) of variable which is used for stratification purposes, used
 #' in the data.frame method. This means that k-anonymity is provided within each category

R/measure_risk.R

@@ -45,7 +45,7 @@
 #' @param obj Object of class \code{\link{sdcMicroObj-class}}
 #' @param x Output of measure_risk() or ldiversity()
 #' @param ... see arguments below
-#' \itemize{
+#' \describe{
 #' \item{data: }{Input data, a data.frame.}
 #' \item{keyVars: }{names (or indices) of categorical key variables (for data-frame method)}
 #' \item{w: }{name of variable containing sample weights}
@@ -54,7 +54,7 @@
 #' \item{fast_hier: }{If TRUE a fast approximation is computed if household data are provided.}
 #' }
 #' @return A modified \code{\link{sdcMicroObj-class}} object or a list with the following elements:
-#' \itemize{
+#' \describe{
 #' \item{global_risk_ER: }{expected number of re-identification.}
 #' \item{global_risk: }{global risk (sum of indivdual risks).}
 #' \item{global_risk_pct: }{global risk in percent.}

R/microaggregation.R

@@ -74,7 +74,7 @@
 #' @return If \sQuote{obj} was of class \code{\link{sdcMicroObj-class}} the corresponding
 #' slots are filled, like manipNumVars, risk and utility. If \sQuote{obj} was
 #' of class \dQuote{data.frame}, an object of class \dQuote{micro} with following entities is returned:
-#' \itemize{
+#' \describe{
 #' \item{\code{x}: }{original data}
 #' \item{\code{mx}: }{the microaggregated dataset}
 #' \item{\code{method}: }{method}

R/rankSwap.R

@@ -7,10 +7,10 @@
 #'
 #' Rank swapping sorts the values of one numeric variable by their numerical
 #' values (ranking).  The restricted range is determined by the rank of two
-#' swapped values, which cannot differ, by definition, by more than \eqn{P}{P}
+#' swapped values, which cannot differ, by definition, by more than P
 #' percent of the total number of observations. Only positive P, R0 and K0 are
 #' used and only one of it must be supplied. If none is supplied, sdcMicro sets
-#' parameter eqn{R0} to 0.95 internally.
+#' parameter r0 to 0.95 internally.
 #'
 #' @name rankSwap
 #' @docType methods