pci_info {pci} | R Documentation |
pci_info
Description
Metadata about the process capability indices (PCIs).
Format
pci_info
- pci_id
-
character
. The ID of the PCI. Corresponds to the row name of the data.frame in R. - name_r
-
character
. The variable name of the PCI, as may be referred to by other metadata fields that contain R code. - name_latex
-
character
. The name of the PCI in LaTeX format. - name_r_expr
-
character
. The name of the PCI in R expression format, useful for working with plot labels or texts in R. To be used withstr2expression(text)
in R. - expr_r
-
character
. An R expression of the PCI, in expanded form. Variable names match parameter names of the PCI's function provided by the package. Can be used withstr2expression(text)
in R. - eq_latex
-
character
. An equation of the PCI in LaTeX format. - attributes
-
AsIs
. The attributes column is essentially an unnamedlist
, thus being a nested data structure. Each element belonging to a PCI is again an unnamedlist
, which holds the actual attributes for that PCI. Each attribute is a namedlist
. Attributes detail additional technical information about the PCI or its related concepts, e.g. the bounds of the PCI. Note, all information pertains to the PCI's function provided by the package. Each actual attribute has a 'type' (singlecharacter
) field, may have a 'target' (character
) field, followed by fields specific to that attribute type. The 'target' field indicates which entity the attribute belongs to, e.g. the PCI or one of its terms.