Skip to content
Snippets Groups Projects
Commit 5131057a authored by dj44vuri's avatar dj44vuri
Browse files

updated help file

parent cc59b5cf
No related branches found
No related tags found
No related merge requests found
#' Creates a dataframe with the design. #' Creates a dataframe with the design.
#' #'
#' @param design The path to a design file #' @param design The path to a design file
#' @param designtype Is it a design created with ngene or with spdesign. Ngene desings should be stored as the standard .ngd output. spdesign should be the spdesign object stored as an RDS file. If designtype is not specified, I try to guess what it is. This is especially helpful if you want to carry out a simulation for both spdesign designs and ngene designs at the same time. #' @param designtype Is it a design created with ngene, spdesign or idefix. use 'ngene', 'spdesign' or 'idefix. Ngene designs should be stored as the standard .ngd output. spdesign should be the spdesign object stored as an RDS file. Idefix objects should also be stored as an RDS file. If designtype is not specified, I try to guess what it is. This is especially helpful if you want to carry out a simulation for both spdesign designs and ngene designs at the same time.
#' @param destype Deprecated. Use designtype instead. #' @param destype Deprecated. Use designtype instead.
#' @return a dataframe #' @return a dataframe
#' @export #' @export
......
...@@ -9,7 +9,7 @@ readdesign(design = designfile, designtype = NULL, destype = NULL) ...@@ -9,7 +9,7 @@ readdesign(design = designfile, designtype = NULL, destype = NULL)
\arguments{ \arguments{
\item{design}{The path to a design file} \item{design}{The path to a design file}
\item{designtype}{Is it a design created with ngene or with spdesign. Ngene desings should be stored as the standard .ngd output. spdesign should be the spdesign object stored as an RDS file. If designtype is not specified, I try to guess what it is. This is especially helpful if you want to carry out a simulation for both spdesign designs and ngene designs at the same time.} \item{designtype}{Is it a design created with ngene, spdesign or idefix. use 'ngene', 'spdesign' or 'idefix. Ngene designs should be stored as the standard .ngd output. spdesign should be the spdesign object stored as an RDS file. Idefix objects should also be stored as an RDS file. If designtype is not specified, I try to guess what it is. This is especially helpful if you want to carry out a simulation for both spdesign designs and ngene designs at the same time.}
\item{destype}{Deprecated. Use designtype instead.} \item{destype}{Deprecated. Use designtype instead.}
} }
......
...@@ -25,7 +25,7 @@ sim_all( ...@@ -25,7 +25,7 @@ sim_all(
\item{resps}{Number of respondents you want to simulate} \item{resps}{Number of respondents you want to simulate}
\item{designtype}{Is it a design created with ngene or with spdesign. Ngene desings should be stored as the standard .ngd output. spdesign should be the spdesign object stored as an RDS file. If designtype is not specified, I try to guess what it is. This is especially helpful if you want to carry out a simulation for both spdesign designs and ngene designs at the same time.} \item{designtype}{Is it a design created with ngene, spdesign or idefix. use 'ngene', 'spdesign' or 'idefix. Ngene designs should be stored as the standard .ngd output. spdesign should be the spdesign object stored as an RDS file. Idefix objects should also be stored as an RDS file. If designtype is not specified, I try to guess what it is. This is especially helpful if you want to carry out a simulation for both spdesign designs and ngene designs at the same time.}
\item{destype}{Deprecated. Use designtype instead.} \item{destype}{Deprecated. Use designtype instead.}
......
...@@ -28,7 +28,7 @@ sim_choice( ...@@ -28,7 +28,7 @@ sim_choice(
\item{ut}{The first element of the utility function list} \item{ut}{The first element of the utility function list}
\item{designtype}{Is it a design created with ngene or with spdesign. Ngene desings should be stored as the standard .ngd output. spdesign should be the spdesign object stored as an RDS file. If designtype is not specified, I try to guess what it is. This is especially helpful if you want to carry out a simulation for both spdesign designs and ngene designs at the same time.} \item{designtype}{Is it a design created with ngene, spdesign or idefix. use 'ngene', 'spdesign' or 'idefix. Ngene designs should be stored as the standard .ngd output. spdesign should be the spdesign object stored as an RDS file. Idefix objects should also be stored as an RDS file. If designtype is not specified, I try to guess what it is. This is especially helpful if you want to carry out a simulation for both spdesign designs and ngene designs at the same time.}
\item{destype}{Deprecated. Use designtype instead.} \item{destype}{Deprecated. Use designtype instead.}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment