checkArguments {modgo}R Documentation

Check Arguments

Description

Check that the arguments are following the corresponding conditions

Usage

checkArguments(
  data = NULL,
  ties_method = "max",
  variables = colnames(data),
  bin_variables = NULL,
  categ_variables = NULL,
  count_variables = NULL,
  n_samples = nrow(data),
  sigma = NULL,
  nrep = 100,
  noise_mu = FALSE,
  pertr_vec = NULL,
  change_cov = NULL,
  change_amount = 0,
  seed = 1,
  thresh_var = NULL,
  thresh_force = FALSE,
  var_prop = NULL,
  var_infl = NULL,
  infl_cov_stable = FALSE,
  tol = 1e-06,
  stop_sim = FALSE,
  new_mean_sd = NULL,
  multi_sugg_prop = NULL,
  generalized_mode = FALSE,
  generalized_mode_model = NULL,
  generalized_mode_lmbds = NULL
)

Arguments

data

a data frame containing the data whose characteristics are to be mimicked during the data simulation.

ties_method

Method on how to deal with equal values during rank transformation. Acceptable input:"max","average","min". This parameter is passed by rbi_normal_transform to the parameter ties.method of rank.

variables

a vector of which variables you want to transform. Default:colnames(data)

bin_variables

a character vector listing the binary variables.

categ_variables

a character vector listing the ordinal categorical variables.

count_variables

a character vector listing the count as a sub sub category of categorical variables. Count variables should be part of categorical variables vector. Count variables are treated differently when using gldex to simulate them.

n_samples

Number of rows of each simulated data set. Default is the number of rows of data.

sigma

a covariance matrix of NxN (N= number of variables) provided by the user to bypass the covariance matrix calculations

nrep

number of repetitions.

noise_mu

Logical value if you want to apply noise to multivariate mean. Default: FALSE

pertr_vec

A named vector.Vector's names are the continuous variables that the user want to perturb. Variance of simulated data set mimic original data's variance.

change_cov

change the covariance of a specific pair of variables.

change_amount

the amount of change in the covariance of a specific pair of variables.

seed

A numeric value specifying the random seed. If seed = NA, no random seed is set.

thresh_var

A data frame that contains the thresholds(left and right) of specified variables (1st column: variable names, 2nd column: Left thresholds, 3rd column: Right thresholds)

thresh_force

A logical value indicating if you want to force threshold in case the proportion of samples that can surpass the threshold are less than 10%

var_prop

A named vector that provides a proportion of value=1 for a specific binary variable(=name of the vector) that will be the proportion of this value in the simulated data sets.[this may increase execution time drastically]

var_infl

A named vector.Vector's names are the continuous variables that the user want to perturb and increase their variance

infl_cov_stable

Logical value. If TRUE,perturbation is applied to original data set and simulations values mimic the perturbed original data set.Covariance matrix used for simulation = original data's correlations. If FALSE, perturbation is applied to the simulated data sets.

tol

A numeric value that set up tolerance(relative to largest variance) for numerical lack of positive-definiteness in Sigma

stop_sim

A logical value indicating if the analysis should stop before simulation and produce only the correlation matrix

new_mean_sd

A matrix that contains two columns named "Mean" and "SD" that the user specifies desired Means and Standard Deviations in the simulated data sets for specific continues variables. The variables must be declared as ROWNAMES in the matrix

multi_sugg_prop

A named vector that provides a proportion of value=1 for specific binary variables(=name of the vector) that will be the close to the proportion of this value in the simulated data sets.

generalized_mode

A logical value indicating if you want to use generalized distribution to simulate your data

generalized_mode_model

A matrix that contains two columns named "Variable" and "Model". This matrix can be used only if a generalized_mode_model argument is provided. It specifies what model should be used for each Variable. Model values should be "RMFMKL", "RPRS", "STAR" or a combination of them, e.g. "RMFMKL-RPRS" or "STAR-STAR", in case the use wants a bimodal simulation. The user can select Generalised Poisson model for poisson variables, but this model cannot be included in bimodal simulation.

generalized_mode_lmbds

A matrix that contains lmbds values for each of the variables of the data set to be used for either Generalized Lambda Distribution Generalized Poisson Distribution or setting up thresholds

Value

No value, called for checking arguments of modgo

Author(s)

Francisco M. Ojeda, George Koliopanos


[Package modgo version 1.0.1 Index]