tableProperties: create a 'tableProperties' object.

In davidgohel/R2DOC: RDocument Tools

Description

Create a tableProperties object without using new("tableProperties", ...).

Usage

tableProperties( header.text = textProperties(font.weight="bold"), header.par = parProperties( text.align = "center" ), header.cell = cellProperties()
, groupedheader.text = textProperties(font.weight="bold"), groupedheader.par = parProperties( text.align = "center" ), groupedheader.cell = cellProperties()
, double.text = textProperties(), double.par = parProperties( text.align = "right" ), double.cell = cellProperties()
, integer.text = textProperties(), integer.par = parProperties( text.align = "right" ), integer.cell = cellProperties()
, percent.text = textProperties(), percent.par = parProperties( text.align = "right" ), percent.cell = cellProperties()
, character.text = textProperties(), character.par = parProperties( text.align = "left" ), character.cell = cellProperties()
, date.text = textProperties(font.style="italic"), date.par = parProperties( text.align = "center" ), date.cell = cellProperties()
, datetime.text = textProperties(font.style="italic"), datetime.par = parProperties( text.align = "center" ), datetime.cell = cellProperties()
, percent.addsymbol = "%", integer.digit = 2L, fraction.double.digit = 2L, fraction.percent.digit = 2L, data.cell, data.par, data.text
)

Arguments

header.text	Object from the class textProperties that represents text formatting properties for column headers
header.par	Object from the class parProperties that represents paragraph formatting properties for column headers
header.cell	Object from the class cellProperties that represents cell formatting properties for column headers
groupedheader.text	Object from the class textProperties that represents text formatting properties for column groupedheaders
groupedheader.par	Object from the class parProperties that represents paragraph formatting properties for column groupedheaders
groupedheader.cell	Object from the class cellProperties that represents cell formatting properties for column groupedheaders
double.text	Object from the class textProperties that represents text formatting properties for columns of type 'double'
double.par	Object from the class parProperties that represents paragraph formatting properties for columns of type 'double'
double.cell	Object from the class cellProperties that represents cell formatting properties for columns of type 'double'
integer.text	Object from the class textProperties that represents text formatting properties for columns of type 'integer'
integer.par	Object from the class parProperties that represents paragraph formatting properties for columns of type 'integer'
integer.cell	Object from the class cellProperties that represents cell formatting properties for columns of type 'integer'
percent.text	Object from the class textProperties that represents text formatting properties for columns of type 'percent'
percent.par	Object from the class parProperties that represents paragraph formatting properties for columns of type 'percent'
percent.cell	Object from the class cellProperties that represents cell formatting properties for columns of type 'percent'
character.text	Object from the class textProperties that represents text formatting properties for columns of type 'character'
character.par	Object from the class parProperties that represents paragraph formatting properties for columns of type 'character'
character.cell	Object from the class cellProperties that represents cell formatting properties for columns of type 'character'
date.text	Object from the class textProperties that represents text formatting properties for columns of type 'date'
date.par	Object from the class parProperties that represents paragraph formatting properties for columns of type 'date'
date.cell	Object from the class cellProperties that represents cell formatting properties for columns of type 'date'
datetime.text	Object from the class textProperties that represents text formatting properties for columns of type 'datetime'
datetime.par	Object from the class parProperties that represents paragraph formatting properties for columns of type 'datetime'
datetime.cell	Object from the class cellProperties that represents cell formatting properties for columns of type 'datetime'
percent.addsymbol	Object from the class character that represents the symbol to add after percent data as been formated (character, default to ”)
integer.digit	the minimum number of digits (to the left of the decimal point for data 'percent' and 'double') in formatting numerical data. Allowed values are integer.digit >=0.
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.
data.cell	Object from the class cellProperties that represents cell formatting properties for columns of any type.
data.par	Object from the class parProperties that represents paragraph formatting properties for columns of any type.
data.text	Object from the class textProperties that represents text formatting properties for columns of any type.

See Also

parProperties
textProperties
cellProperties
tableProperties object

Examples

tableProperties(header.text = textProperties(font.weight="bold")
	, header.par = parProperties( text.align = "center" ))
	
	
# creation of another tableProperties
header.cellProperties = cellProperties( border.left.width = 0, border.right.width = 0
		, border.bottom.width = 1, border.top.width = 0
		, padding = 3 )
data.cellProperties = cellProperties( border.left.width = 0, border.right.width = 0
		, border.bottom.width = 1, border.top.width = 0
		, padding = 2 )
		
header.textProperties = textProperties( font.size = 10, font.weight = "bold" )
data.textProperties = textProperties( font.size = 10 )

leftPar = parProperties( text.align = "left", padding.left = 4, padding.right = 4)
rightPar = parProperties( text.align = "right", padding.left = 4, padding.right = 4)
centerPar = parProperties( text.align = "center", padding.left = 4, padding.right = 4)

my.formats = tableProperties( 
			  character.par = leftPar
			, percent.par = rightPar
			, double.par = rightPar
			, integer.par = rightPar
			, groupedheader.par = centerPar
			, groupedheader.text = header.textProperties
			, groupedheader.cell = header.cellProperties
			, header.cell = header.cellProperties
			, header.par = centerPar
			, header.text = header.textProperties
			, data.cell = data.cellProperties
			, data.text = data.textProperties
)

davidgohel/R2DOC documentation built on May 14, 2019, 11:11 p.m.