File: newTable.Rd

package info (click to toggle)
r-cran-nozzle.r1 1.1-1.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 800 kB
  • sloc: javascript: 553; makefile: 12
file content (42 lines) | stat: -rw-r--r-- 1,118 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
\name{newTable}
\alias{newTable}
\title{Create new table element.}
\usage{
  newTable(table, ..., file = NA,
    significantDigits = TABLE.SIGNIFICANT.DIGITS,
    exportId = NULL, protection = PROTECTION.PUBLIC)
}
\arguments{
  \item{table}{A matrix or data frame containing the table
  data. Column names will be extracted and used as column
  headers.}

  \item{...}{Strings that will be concatenated to form the
  table caption.}

  \item{file}{Path or URL to a file containing the full
  table. It is recommend to only show a relevant subset of
  all results in the report itself to increase
  readability.}

  \item{significantDigits}{Number of significant digits
  used to trim all numeric columns. The default is
  \code{TABLE.SIGNIFICANT.DIGITS}.}

  \item{exportId}{Unique string to identify this element.
  Used to retrieve the element using
  \code{getExportedElement}.}

  \item{protection}{Procection level. One of
  PROTECTION.PUBLIC, PROTECTION.GROUP, PROTECTION.PRIVATE.}
}
\value{
  New element.
}
\description{
  Create new table element.
}
\author{
  Nils Gehlenborg \email{nils@hms.harvard.edu}
}