File: getParamTypes.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 (47 lines) | stat: -rw-r--r-- 1,276 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
40
41
42
43
44
45
46
47
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/getParamTypes.R
\name{getParamTypes}
\alias{getParamTypes}
\title{Returns type information for a parameter set.}
\usage{
getParamTypes(
  par.set,
  df.cols = FALSE,
  df.discretes.as.factor = TRUE,
  use.names = FALSE,
  with.nr = TRUE
)
}
\arguments{
\item{par.set}{\link{ParamSet}\cr
Parameter set.}

\item{df.cols}{(\code{logical(1)})\cr
If \code{FALSE} simply return the parameter types in the set,
i.e., \code{par$type}.
If \code{TRUE}, convert types so they correspond to R types of a data.frame
where values of this set might be stored.
This also results in replication of output types for
vector parameters.
Default is \code{FALSE}.}

\item{df.discretes.as.factor}{(\code{logical(1)})\cr
If \code{df.cols} is \code{TRUE}:
Should type for discrete params be \code{factor} or \code{character}?
Default is \code{TRUE}.}

\item{use.names}{(\code{logical(1)})\cr
Name the result vector?
Default is \code{FALSE}.}

\item{with.nr}{(\code{logical(1)})\cr
Should number from 1 to length be appended to name?
Only used if \code{use.names} and \code{df.cols} are \code{TRUE}.
Default is \code{TRUE}.}
}
\value{
\code{\link{character}}.
}
\description{
Returns type information for a parameter set.
}