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
48
49
50
51
52
53
54
55
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/paramValueToString.R
\name{paramValueToString}
\alias{paramValueToString}
\title{Convert a value to a string.}
\usage{
paramValueToString(par, x, show.missing.values = FALSE, num.format = "\%.3g")
}
\arguments{
\item{par}{(\link{Param} | \link{ParamSet})\cr
Parameter or parameter set.}
\item{x}{(any)\cr
Value for parameter or value for parameter set. In the latter case it must
be named list. For discrete parameters their values must be used, not their
names.}
\item{show.missing.values}{(\code{logical(1)})\cr
Display \dQuote{NA} for parameters, which have no setting, because their
requirements are not satisfied (dependent parameters), instead of
displaying nothing? Default is \code{FALSE}.}
\item{num.format}{(\code{character(1)})\cr
Number format for output of numeric parameters. See the details section of
the manual for \code{\link[base:sprintf]{base::sprintf()}} for details.}
}
\value{
\code{character(1)}.
}
\description{
Useful helper for logging.
For discrete parameter values always the name of the discrete value is used.
}
\examples{
p = makeNumericParam("x")
paramValueToString(p, 1)
paramValueToString(p, 1.2345)
paramValueToString(p, 0.000039)
paramValueToString(p, 8.13402, num.format = "\%.2f")
p = makeIntegerVectorParam("x", len = 2)
paramValueToString(p, c(1L, 2L))
p = makeLogicalParam("x")
paramValueToString(p, TRUE)
p = makeDiscreteParam("x", values = list(a = NULL, b = 2))
paramValueToString(p, NULL)
ps = makeParamSet(
makeNumericVectorParam("x", len = 2L),
makeDiscreteParam("y", values = list(a = NULL, b = 2))
)
paramValueToString(ps, list(x = c(1, 2), y = NULL))
}
|
