parse_title: Parse keywords in string based on values contained in an xpdb

View source: R/xplot_helpers.R

parse_titleR Documentation

Parse keywords in string based on values contained in an xpdb

Description

Parse keywords in string based on values contained in an xpdb

Usage

parse_title(
  string,
  xpdb,
  problem,
  quiet,
  extra_key = NULL,
  extra_value = NULL,
  ignore_key = NULL
)

Arguments

string

A string containing keywords (e.g. '@nobs') to be parsed (e.g. title, label, etc.) using values stored in the 'xpdb$summary'.

xpdb

An xpose database object.

problem

The $problem number to be used.

quiet

Should messages be displayed to the console.

extra_key

A vector of additional keywords not available in the 'xpdb$summary'.

extra_value

A vector of values matching the order of 'extra_key'.

ignore_key

A vector of keywords to be ignored i.e. warnings will not be returned.

Value

The parsed 'string'.


xpose documentation built on July 9, 2023, 6:12 p.m.