get_PAR_sample: Get Parameter Value Samples

View source: R/DataSet.R

get_PAR_sampleR Documentation

Get Parameter Value Samples

Description

Get Parameter Value Samples

Usage

get_PAR_sample(ds, idxValue, ...)

## S3 method for class 'DataSet'
get_PAR_sample(
  ds,
  idxValue,
  parId = "all",
  which = "by_FV",
  output = "wide",
  ...
)

## S3 method for class 'DataSetList'
get_PAR_sample(ds, idxValue, algorithm = "all", ...)

Arguments

ds

A DataSet or DataSetList object

idxValue

A Numerical vector. Index values at which parameter values are observed. The index value can either take its value in the range of running times, or function values. Such a value type is signified by 'which' parameter.

...

Arguments passed to other methods

parId

A character vector. Either 'all' or the name of parameters to be retrieved

which

A string takes values in ‘c(’by_FV', 'by_RT')', indicating the parameters to be retrieved are aligned against the running time (RT) or function value (FV). ''by_FV'' is the default value.

output

A character. The format of the output data: 'wide' or 'long'

algorithm

DEPRECATED, will be removed in next release. Which algorithms in the DataSetList to consider.

Value

A data.table object containing parameter values aligned at each given target value

Examples

get_PAR_sample(dsl, 14)
get_PAR_sample(dsl[[1]], 14)

IOHanalyzer documentation built on Sept. 20, 2023, 5:07 p.m.