Nothing
#' Overview over the parameters used in the \code{randomizeR} package
#'
#' This list of parameters yields a comprehensive overview of the parameters
#' used in the \code{randomizeR} package.
#'
#' @param a nonnegative parameter which controls the degree of randomness:
#' For decreasing \code{a} the allocations become deterministic, while for increasing
#' \code{a} the randomization procedure tends to complete randomization.
#' @param accrualTime duration of the accrual period in a survival study.
#' @param add integer representing the number of balls that are added to the
#' urn in each step.
#' @param alpha the significance level of the test in each simulation.
#' @param bc vector which contains the lengths \code{k_1,...,k_l} of each block.
#' This means that the vector \code{bc} will have one entry for each block.
#' @param b numeric vector of length at most 2 specifying the weight(s) for the punishment of
#' deviations from the target value.
#' @param cenRate exponential censoring rate in a survival study.
#' @param cenTime total duration of a survival study (maximum length of followup).
#' @param d effect size.
#' @param df degrees of freedom (i.a. \code{N-2}).
#' @param eta numeric specifying the magnitude of selection bias.
#' @param file A connection, or a character string naming the file to write to.
#' @param filledBlock \code{logical} whether the last block should be filled or not.
#' @param FTI final tolerated imbalance. This is the difference in number of
#' patients of groups A and B that is permitted at the end of a trial. Usually
#' this is set to zero.
#' @param groups character vector of labels for the different treatments.
#' @param ini integer representing the initial urn composition.
#' @param k length of the block to be permuted. \code{k} should be divisible by
#' the number of treatment arms.
#' @param K number of treatment groups (e.g. K=2 if we compare one experimental
#' against one control treatment).
#' @param lb lower bound for the starting value of the poisson distribution.
#' @param lambda vector of the exponential rate parameters in each treatment group.
#' @param method method that is used to generate the (random) allocation
#' sequence. It can take values \code{PBR}, \code{RAR}, \code{HAD}, \code{PWR},
#' \code{EBC}, \code{BSD}, \code{CR}, \code{TBD}, \code{UD}, and \code{MP}.
#' @param mti maximum tolerated imbalance in patient numbers during the trial.
#' @param mu vector of the expected responses of the treatment groups, should have
#' length \code{K}
#' (i.e. one entry for each treatment group).
#' @param N integer for the total sample size of the trial.
#' @param name name of a variable.
#' @param obj object specifying the randomization procedure, see \code{\link{randPar}}
#' or \code{\link{createParam}}.
#' @param object any R object.
#' @param p success probability of the biased coin (e.g. in Efron's Biased Coin
#' Design).
#' @param pr vector with patient responses, i.e. each patients resulting value
#' after the treatment.
#' @param q "cut-off" value in \code{[0.5,1]}. This is the ratio of patients up
#' from which the experimenter imposes selection bias on the data.
#' @param r numeric indicating the number of random sequences to be generated at
#' random, or missing.
#' @param ratio vector of length \code{K}. The total sample number \code{N} and
#' all used block lengths (\code{bc}) have to be divisible by \code{sum(ratio)}.
#' @param rb block lengths of the blocks that can be selected equiprobable at random.
#' @param rho nonnegative parameter which my be adjusted according to how strongly it is
#' desired to balance the experiment. If \code{rho = 1}, we have Wei's urn design with
#' \code{alpha = 0}. If \code{rho = 0}, we have complete randomization.
#' @param rsob randomization sequence (of one block).
#' @param rs randomization sequence (of all blocks).
#' @param S matrix for the computation of the probabilities in the maximal
#' procedure.
#' @param saltus integer or \code{missing} specifying the patient index (i.e. position)
#' of the step in case of step time trend.
#' @param seed a single value, interpreted as an integer, that specifies the seed
#' for the random number generation.
#' @param sigma vector of the standard deviations in each treatment group,
#' should have length \code{K} (i.e. one entry for each treatment group).
#' @param SLs numeric vector of length at most 2 specifying the lower and/or upper
#' specified border.
#' @param theta factor of the time trend for further details see \code{type}.
#' @param type character vector indicating which biasing strategy the
#' experimenter is using (selection bias) and which other bias is present in the
#' clinical trial (e.g. time trend). All biases included in the vector are
#' combined (i.e. added up) to form the total bias. Possible values are
#' \code{"none"} (if no bias occurs), \code{"CS"} (resp. \code{"DS"}) (if the
#' experimenter uses the convergence (resp. divergence) strategy to invoke
#' selection bias), \code{LinT} for linear time trend, \code{LogT} for
#' log-linear time trend, \code{StepT} for step time trend, \code{SigT} for
#' sigmoid time trend, \code{PWR} for knowledge of all up to the first
#' observation in each block, \code{MTI} the next observation after reaching the
#' maximal tolerated imbalance is reached will be known to the physician.
#' @param TV numeric specifying the optimal desired value called the target value.
#' @param ub upper bound for the last value of the poisson distribution.
#' @param varEq \code{logical} parameter for the t.test: Shall the variances be treated
#' as equal (TRUE= t.test) or different (FALSE= Welch.test).
#' @param x a variable \code{x}.
#' @param allocRatio numerical vector that represents the allocation ratio for the different strata in a clinical trial
#' @param strata numeric specifying the number of strata in a clinical trial
#' @param maxcombo logical specifying if the maxcombo test is used
#' @param weights numeric specifying the weights used for the test. Unless specified an unweighted test is conducted.
#'
#' @name overview
NULL
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.