parframe: Generate a parameter frame

View source: R/04_profile_tools.R

parframeR Documentation

Generate a parameter frame

Description

A parameter frame is a data.frame where the rows correspond to different parameter specifications. The columns are divided into three parts. (1) the meta-information columns (e.g. index, value, constraint, etc.), (2) the attributes of an objective function (e.g. data contribution and prior contribution) and (3) the parameters.

Usage

parframe(
  x = NULL,
  parameters = colnames(x),
  metanames = NULL,
  obj.attributes = NULL
)

Arguments

x

data.frame.

parameters

character vector, the names of the parameter columns.

metanames

character vector, the names of the meta-information columns.

obj.attributes

character vector, the names of the objective function attributes.

Details

Parameter frames can be subsetted either by [ , ] or by subset. If [ , index] is used, the names of the removed columns will also be removed from the corresponding attributes, i.e. metanames, obj.attributes and parameters.

Value

An object of class parframe, i.e. a data.frame with attributes for the different names. Inherits from data.frame.

See Also

profile, mstrust


SeverinBang/blotIt3 documentation built on April 4, 2022, 5 a.m.