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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/OptPathDF_as_data_frame.R
\name{as.data.frame.OptPathDF}
\alias{as.data.frame.OptPathDF}
\title{Convert optimization path to data.frame.}
\usage{
\method{as.data.frame}{OptPathDF}(
x,
row.names = NULL,
optional = FALSE,
include.x = TRUE,
include.y = TRUE,
include.rest = TRUE,
dob = x$env$dob,
eol = x$env$eol,
...
)
}
\arguments{
\item{x}{(\code{\link[=OptPath]{OptPath()}})\cr
Optimization path.}
\item{row.names}{\link{character}\cr
Row names for result.
Default is none.}
\item{optional}{(any)\cr
Currently ignored.}
\item{include.x}{(\code{logical(1)})\cr
Include all input params?
Default is \code{TRUE}.}
\item{include.y}{(\code{logical(1)})\cr
Include all y-columns?
Default is \code{TRUE}.}
\item{include.rest}{(\code{logical(1)})\cr
Include all other columns?
Default is \code{TRUE}.}
\item{dob}{\link{integer}\cr
Vector of date-of-birth values to further subset the result.
Only elements with a date-of-birth included in \code{dob} are selected.
Default is all.}
\item{eol}{\link{integer}\cr
Vector of end-of-life values to further subset the result.
Only elements with an end-of-life included in \code{eol} are selected.
Default is all.}
\item{...}{(any) \cr
Currently ignored.}
}
\value{
\code{\link{data.frame}}.
}
\description{
The following types of columns are created:
\tabular{ll}{
x-numeric(vector) \tab \code{numeric} \cr
x-integer(vector) \tab \code{integer} \cr
x-discrete(vector) \tab \code{factor} (names of values = levels) \cr
x-logical(vector) \tab \code{logical} \cr
y-columns \tab \code{numeric} \cr
dob \tab \code{integer} \cr
eol \tab \code{integer} \cr
error.message \tab \code{character} \cr
exec.time \tab \code{numeric} \cr
extra-columns \tab any \cr
}
If you want to convert these, look at \code{\link[BBmisc:convertDataFrameCols]{BBmisc::convertDataFrameCols()}}.
Dependent parameters whose constraints are unsatisfied generate \code{NA} entries
in their respective columns. Factor columns of discrete parameters always
have their complete level set from the \code{param.set}.
}
|
