ReporteRs (version 0.5.8)

tableProperties: Table formatting properties

Description

Create an object that describes table formatting properties.

Usage

tableProperties(header.text = textProperties(font.size = 12, font.weight =
  "bold"), header.par = parProperties(padding = 3, text.align = "left"),
  header.cell = cellProperties(border.width = 1, background.color =
  "#e8eaeb"), groupedheader.text = textProperties(font.size = 12, font.weight
  = "bold"), groupedheader.par = parProperties(padding = 3, text.align =
  "left"), groupedheader.cell = cellProperties(border.width = 1,
  background.color = "#e8eaeb"), double.text = textProperties(font.size = 12),
  double.par = parProperties(padding = 3, text.align = "left"),
  double.cell = cellProperties(), integer.text = textProperties(font.size =
  12), integer.par = parProperties(padding = 3, text.align = "left"),
  integer.cell = cellProperties(), percent.text = textProperties(font.size =
  12), percent.par = parProperties(padding = 3, text.align = "left"),
  percent.cell = cellProperties(), character.text = textProperties(font.size
  = 12), character.par = parProperties(padding = 3, text.align = "left"),
  character.cell = cellProperties(), date.text = textProperties(font.size =
  12, font.style = "italic"), date.par = parProperties(padding = 3, text.align
  = "left"), date.cell = cellProperties(),
  datetime.text = textProperties(font.size = 12, font.style = "italic"),
  datetime.par = parProperties(padding = 3, text.align = "left"),
  datetime.cell = cellProperties(), logical.text = textProperties(font.size
  = 12, font.style = "italic"), logical.par = parProperties(padding = 3,
  text.align = "left"), logical.cell = cellProperties(),
  percent.addsymbol = "%",
  locale.language = getOption("ReporteRs-locale.language"),
  locale.region = getOption("ReporteRs-locale.region"),
  fraction.double.digit = 4L, fraction.percent.digit = 3L, data.cell,
  data.par, data.text)

Arguments

data.cell

cell formatting properties for columns of any type. Overwrites any *.cell (except headers)

data.par

paragraph formatting properties for columns of any type. Overwrites any *.par (except headers)

data.text

text formatting properties for columns of any type. Overwrites any *.text (except headers)

header.text

text formatting properties of column headers

header.par

paragraph formatting properties of column headers

header.cell

cell formatting properties of column headers

groupedheader.text

text formatting properties of groupedheaders

groupedheader.par

paragraph formatting properties of groupedheaders

groupedheader.cell

cell formatting properties of groupedheaders

double.text

text formatting properties of columns of type 'double'

double.par

paragraph formatting properties for columns of type 'double'

double.cell

cell formatting properties for columns of type 'double'

integer.text

text formatting properties for columns of type 'integer'

integer.par

paragraph formatting properties for columns of type 'integer'

integer.cell

cell formatting properties for columns of type 'integer'

percent.text

text formatting properties for columns of type 'percent'

percent.par

paragraph formatting properties for columns of type 'percent'

percent.cell

cell formatting properties for columns of type 'percent'

character.text

text formatting properties for columns of type 'character'

character.par

paragraph formatting properties for columns of type 'character'

character.cell

cell formatting properties for columns of type 'character'

date.text

text formatting properties for columns of type 'date'

date.par

paragraph formatting properties for columns of type 'date'

date.cell

cell formatting properties for columns of type 'date'

logical.text

text formatting properties for columns of type 'logical'

logical.par

paragraph formatting properties for columns of type 'logical'

logical.cell

cell formatting properties for columns of type 'logical'

datetime.text

text formatting properties for columns of type 'datetime'

datetime.par

paragraph formatting properties for columns of type 'datetime'

datetime.cell

cell formatting properties for columns of type 'datetime'

percent.addsymbol

represents the symbol to add after percent data as been formated (character, default to '')

fraction.double.digit

the minimum number of digits to the right of the decimal point in formatting 'double' data. Allowed values are fraction.double.digit >=0.

fraction.percent.digit

the minimum number of digits to the right of the decimal point in formatting 'percent' data. Allowed values are fraction.percent.digit >=0.

locale.language

locale language symbol ("fr, "en", etc.) - default to getOption("ReporteRs-locale.language")

locale.region

locale region symbol ("FR, "US", etc.) - default to getOption("ReporteRs-locale.region")

Details

tableProperties is used to control table format when addTable is used. One can customize headers (or grouped headers) and content. Headers share all the same format. Content is formated according to its data type (col.types argument in addTable). "double" columns share all the same format, "character" columns share all the same format, etc. Conditionnal formatting is not specified in tableProperties but in addTable.

See Also

addTable

Examples

# NOT RUN {
# define table properties - set headers aligned on the right, font color
# is gray and font size is 12 points
tableProperties( header.text = textProperties(color="gray", font.size = 12)
		, header.par = parProperties( text.align = "right" )
)
# }