Skip to content
Snippets Groups Projects
init_variable.Rd 777 B
Newer Older
Arnaud Duvermy's avatar
Arnaud Duvermy committed
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/simulation_initialization.R
\name{init_variable}
\alias{init_variable}
\title{Initialize variable}
\usage{
Arnaud Duvermy's avatar
Arnaud Duvermy committed
init_variable(list_var = c(), name = "myVariable", sd = NA, level = NA, mu = 0)
Arnaud Duvermy's avatar
Arnaud Duvermy committed
}
\arguments{
\item{list_var}{Either c() or output of init_variable}

\item{name}{Variable name}

Arnaud Duvermy's avatar
Arnaud Duvermy committed
\item{sd}{Either numeric value or NA. Use to specify range of effect sizes.}
Arnaud Duvermy's avatar
Arnaud Duvermy committed

\item{level}{Numeric value to specify the number of levels to simulate}
Arnaud Duvermy's avatar
Arnaud Duvermy committed

\item{mu}{Either a numeric value or a numeric vector (of length = level). Default : 0. Not recommended to modify.}
Arnaud Duvermy's avatar
Arnaud Duvermy committed
}
\value{
A list with initialized variables
}
\description{
Initialize variable
}
\examples{
Arnaud Duvermy's avatar
Arnaud Duvermy committed
init_variable(name = "my_varA", sd = 9, level = 200)
Arnaud Duvermy's avatar
Arnaud Duvermy committed
}