addParagraph-methods: Insert a paragraph of text into the docx document

In davidgohel/R2DOCX: Create MS docx documents from R

Description

Insert a paragraph of text into a Docx object.

Usage

  ## S4 method for signature 'Docx, character, character, list, list, character'
addParagraph(x, value, stylename, replacements, replacement.styles, bookmark)

Arguments

x	the Docx to use
value	character vector containing texts to add.
stylename	value of the named style in the docx document.
replacements	optional, a named list whose elements define replacements values.
replacement.styles	optional, a named list specifying formats to apply to replacements.
bookmark	a character value ; id of the Word bookmark to replace by the table. optional

Details

• value : text(s) to add, a character vector.
  Example : value="Hello world"
  If replacements have to be done, keywords that identify text to be replaced must be contained into square brackets [].
  Example : value="At the [ALPHA] significance level, one [DECISION] the null hypothesis."
  

• replacements : a name list, names are keywords (of the value , contained into square brackets) and values are replacements values
  Example : value = "[animal] eats [food]."
, replacements = list( animal = "donkey" , food = "grass" )
  

• replacement.styles : a name list, names are keywords (of the value , contained into square brackets) and values are replacements styles values
  Example : value = "[animal] eats [food]."
, replacements = list( animal = "donkey" , food = "grass" )
, replacement.styles = list( animal= textProperties(color="red" ) , food= textProperties(color="blue" ) )
  

• bookmark : a character vector specifying bookmark id to replace by the table. If provided, table will replace the paragraph that contains the bookmark. If not provided, table will be added at the end of the document.

Examples

doc <- new("Docx", title = "My example" )

doc <- addParagraph( doc, value = "Hello", stylename = "Normal")




x = c( "[animal] eat [food].", "tigers eat [animal]." )

repl.styles = list(
		  animal= textProperties( font.size = 12, font.family="Courier New", color="red" )
		, food= textProperties( font.size = 12, font.family="Courier New", color="blue" )
)
repl = list( animal = "buffalos" , food = "grass" )

doc <- addParagraph( doc, value = x, stylename = "Normal"
		, replacements = repl
		, replacement.styles = repl.styles
)
doc <- addParagraph( doc, value = letters[1:10], stylename = "BulletList")

## Not run: 
writeDoc( doc, "Paragraph_example.docx" )

## End(Not run)

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