showRatioOfQsprays {ratioOfQsprays}R Documentation

Print a 'ratioOfQsprays' object

Description

Prints a ratioOfQsprays object given a function to print a qspray object

Usage

showRatioOfQsprays(
  showQspray,
  quotientBar = "  %//%  ",
  lbracket = "[ ",
  rbracket = " ]"
)

Arguments

showQspray

a function which prints a qspray object, which will be applied to the numerator and the denominator

quotientBar

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

lbracket, rbracket

used to enclose the numerator and the denominator

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<-. That said, one would more often uses showRatioOfQspraysX1X2X3 or showRatioOfQspraysXYZ for this option, which are both built with showRatioOfQsprays.

See Also

showRatioOfQspraysX1X2X3, showRatioOfQspraysXYZ, showRatioOfQspraysOption<-, showQspray.

Examples

set.seed(666)
( roq <- rRatioOfQsprays() )
f <- showRatioOfQsprays(showQsprayX1X2X3("a"), " / ", "[[ ", " ]]")
f(roq)
# this is equivalent to
f <- showRatioOfQspraysX1X2X3("a", " / ", lbracket = "[[ ", rbracket = " ]]")
f(roq)

[Package ratioOfQsprays version 1.1.0 Index]