showRatioOfQspraysX1X2X3 {ratioOfQsprays}R Documentation

Print a 'ratioOfQsprays'

Description

Print a ratioOfQsprays object given a string to denote the non-indexed variables.

Usage

showRatioOfQspraysX1X2X3(var, quotientBar = "  %//%  ", ...)

Arguments

var

a string, usually a letter, to denote the non-indexed variables

quotientBar

a string representing the quotient bar between the numerator and the denominator, including surrounding spaces, e.g " / "

...

arguments other than quotientBar passed to showRatioOfQsprays

Value

A function which takes as argument a ratioOfQsprays object and which prints it.

Note

The function returned by this function can be used as the option "showRatioOfQsprays" of the setter function showRatioOfQspraysOption<-. If you do not use the ellipsis arguments, this is equivalent to set the "x" option and the "quotientBar" option (see example).

See Also

showRatioOfQspraysXYZ, showRatioOfQspraysOption<-.

Examples

set.seed(666)
( roq <- rRatioOfQsprays() )
showRatioOfQspraysX1X2X3("X", " / ")(roq)
# setting a show option:
showRatioOfQspraysOption(roq, "showRatioOfQsprays") <-
  showRatioOfQspraysX1X2X3("X", " / ")
roq
# this is equivalent to set the "x" and "quotientBar" options:
showRatioOfQspraysOption(roq, "x") <- "X"
showRatioOfQspraysOption(roq, "quotientBar") <- " / "

[Package ratioOfQsprays version 1.1.0 Index]