RpadHTML {Rpad}R Documentation

Rpad utilities

Description

Rpad utilities to generate HTML output.

Usage

  ROutputFormat(Format)
  HTMLon()
  HTMLoff()
  HtmlTree(tagName, ..., standaloneTag = FALSE, collapseContents = TRUE)
  H(tagName, ..., standaloneTag = FALSE, collapseContents = TRUE)
  HTML(x,...)
  BR
  HTMLh1(text)
  HTMLh2(text)
  HTMLh3(text)
  HTMLh4(text)
  HTMLh5(text)
  HTMLargs(x)
  HTMLtag(tagName, ...)
  HTMLetag(tagName)
  HTMLradio(variableName, commonName = "radio", text = "", ...)
  HTMLcheckbox(name, text = "", ...)
  HTMLselect(name, text, default = 1, size = 1, id = name, contenteditablewrapper = TRUE, optionvalue = text, ...)
  HTMLinput(name, value = "", rpadType = "Rvariable", contenteditablewrapper = TRUE, ...)
  HTMLlink(url, text, ...)
  HTMLimg(filename = RpadPlotName(), ...)
  HTMLembed(filename, width = 600, height = 600, ...)
  HTML.data.frame(x, ...)
  print.condition(x, ...)

Arguments

Format a string specifying the desired output format, like "html", "text", or "none"
text specifies the text to be displayed in the HTML output.
tagName is a string specifying the HTML nodeName ("H1" or "DIV" for example).
standaloneTag is a logical that specifies whether the HTML tag is a standalone tag, meaning it has no ending tag (<br/> for example).
collapseContents is a logical that specifies whether vector tag contents are collapsed (merged).
variableName, commonName specify attributes of the radio element. commonName specifies the common radio elements that are grouped together (the name attribute of the radio element)–this gets translated into the R variable with the same name. variableName is the string result assigned to commonName when this radio item is selected (the value attribute of the radio element).
name is the name attribute in HTML that is translated into the R variable with the same name.
value is the initial value of the input box.
url is the URL for the <A> element.
contenteditablewrapper is a logical that specifies whether a wrapper is placed around the output to disable editing. Internet Explorer needs this to make links and input elements active.
default, size, id, optionvalue specify parameters of a select box. default specifies which of the options is selected initially.
filename, width, height are parameters of an IMG or EMBED object.
rpadType is the "rpadType" attribute of an INPUT element. Normal values are either "Rvariable" or "Rstring" but other values of "rpadType" should also be possible.
x == To define ==
... arguments are passed on as HTML arguments for the given tag.

Details

HTMLon and HTMLoff specify how Rpad interprets results (either HTML or text). Rpad output sections are normally rendered as plain text with a fixed-width font, so text script outputs are formatted properly. The output blocks can also contain HTML codes for displaying images or for formatting blocks. To change to HTML formatting, use HTMLon() (which sends '<htmlon/>' to the output). To turn HTML mode off, use HTMLoff() (which sends '<htmloff/>'). HTMLon and HTMLoff only apply to the existing Rpad input section; they don't carry over into the next.

H generates HTML (or other XML-like syntax) for an arbitrary tag with the specified name and arguments. Unnamed parameters to H are content, and named parameters are tag attributes. By using nesting, it's a good way to generate HTML (or any XML) with properly formed tags. If tagName is NULL, then the contents are created without a surrounding tag. For vectors, each vector element becomes surrounded by tags, so H("div", c(1,2,3)) results in <div>1</div><div>2</div><div>3</div>.

ROutputMode changes how R behaves with automatic printing. Possible values are: "text" (the default), "html", or "none". "text" is like at the command line: values returned in the script are automatically printed (without an explicit print statement) in standard text format. With "html", values returned are automatically printed, but HTML output is generated by using the HTML method instead of the print method. ROutputMode applies to all subsequent Rpad input section, including a rollover back to the beginning when a page is run several times.

Value

All of the HTML code generation routines return a character string of class HtmlTree. With automatic printing, the string is sent to the output (with cat). This has the effect that the HTML is displayed in Rpad. Note that if a HTML generation function is used inside of a loop or other scenario where the function results are not automatically printed, then you need to enclose the function with cat or print.
HTMLargs returns a string with the arguments as "a='arg1' b='arg2'", and so on. Note the use of single quotes. This will affect how quoted strings should be passed as elements.

Author(s)

Tom Short, EPRI Solutions, Inc., (tshort@eprisolutions.com)

See Also

R2HTML for other useful HTML routines that can be used in Rpad.

Examples

  a <- data.frame(x = 1:10, y = (1:10)^3)

  # fancy HTML output
  HTMLon()
  H(summary(a))
  HTMLoff()
  summary(a)

  # generate some GUI elements
  # - normally done in an Rpad_input section with rpad_run="init"
  HTMLon() # switch to html mode
  data(state)
  HTMLselect("favoriteAmericanState", state.name) # generate the select box

  H("div", "Hello world") # a simple div: "<div>Hello world</div>"
  H("div", class="helloStyle", "Hello world") # a div with a class
    # --> "<div class='helloStyle'>Hello world</div>"

  # you can nest them:
  H("div", class = "myClass", dojoType = "tree",
    "This is some text in the div ",  
    H("em", "emphasized"), "plus some more",
    "and more",
    H("div", class = "anotherClass",
      "text in the div",
      c(1,5,8)))

[Package Rpad version 1.1.0 Index]