File: getOptPathEl.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 (45 lines) | stat: -rw-r--r-- 1,397 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/OptPath_getter.R
\name{getOptPathEl}
\alias{getOptPathEl}
\title{Get an element from the optimization path.}
\usage{
getOptPathEl(op, index)
}
\arguments{
\item{op}{\link{OptPath}\cr
Optimization path.}

\item{index}{(\code{integer(1)})\cr
Index of element.}
}
\value{
List with elements \code{x} (named \code{list}), \code{y} (named \code{numeric}),
\code{dob} \code{integer(1)}, \code{eol} \code{integer(1)}.
The elements \code{error.message} (\code{character(1)}),
\code{exec.time} (\code{numeric(1)}) and \code{extra} (named \code{list}) are
there if the respective options in \code{\link[=OptPath]{OptPath()}} are enabled.
}
\description{
Dependent parameters whose requirements are not satisfied are represented by a scalar NA
in the elements of \code{x} of the return value.
}
\seealso{
Other optpath: 
\code{\link{OptPath}},
\code{\link{addOptPathEl}()},
\code{\link{getOptPathBestIndex}()},
\code{\link{getOptPathCol}()},
\code{\link{getOptPathCols}()},
\code{\link{getOptPathDOB}()},
\code{\link{getOptPathEOL}()},
\code{\link{getOptPathErrorMessages}()},
\code{\link{getOptPathExecTimes}()},
\code{\link{getOptPathLength}()},
\code{\link{getOptPathParetoFront}()},
\code{\link{getOptPathX}()},
\code{\link{getOptPathY}()},
\code{\link{setOptPathElDOB}()},
\code{\link{setOptPathElEOL}()}
}
\concept{optpath}