File: generateDesignOfDefaults.Rd

package info (click to toggle)
r-cran-paramhelpers 1.14.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 992 kB
  • sloc: ansic: 102; sh: 13; makefile: 2
file content (39 lines) | stat: -rw-r--r-- 1,750 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/generateDesignOfDefaults.R
\name{generateDesignOfDefaults}
\alias{generateDesignOfDefaults}
\title{Generates a design with the defaults of a parameter set.}
\usage{
generateDesignOfDefaults(par.set, trafo = FALSE)
}
\arguments{
\item{par.set}{\link{ParamSet}\cr
Parameter set.}

\item{trafo}{(\code{logical(1)})\cr
Transform all parameters by using theirs respective transformation
functions. Default is \code{FALSE}.}
}
\value{
\link{data.frame}. Columns are named by the ids of the parameters. If the
\code{par.set} argument contains a vector parameter, its corresponding column
names in the design are the parameter id concatenated with 1 to dimension
of the vector. The result will have an \code{logical(1)} attribute
\dQuote{trafo}, which is set to the value of argument \code{trafo}.
}
\description{
The following types of columns are created:
\tabular{ll}{
numeric(vector)   \tab  \code{numeric}  \cr
integer(vector)   \tab  \code{integer}  \cr
discrete(vector)  \tab  \code{factor} (names of values = levels) \cr
logical(vector)   \tab  \code{logical}
}
This will create a design containing only one point at the default values of
the supplied param set. In most cases you will combine the resulting
\code{data.frame} with a different generation function e.g. \code{\link[=generateDesign]{generateDesign()}},
\code{\link[=generateRandomDesign]{generateRandomDesign()}} or \code{\link[=generateGridDesign]{generateGridDesign()}}. This is useful to force
an evaluation at the default location of the parameters while still
generating a design. Parameters default values, whose conditions (\code{requires})
are not fulfilled will be set to \code{NA} in the result.
}