includeMap {EpiReport}

Including PNG map in the 'Microsoft Word' template

Description

Function including the disease-specific PNG map in the 'Word' document at the specific bookmark location.

Usage

includeMap(
  disease,
  year,
  reportParameters,
  index,
  pathPNG,
  doc,
  pop,
  namePNGsuffix,
  unit,
  mapBookmark,
  captionBookmark
)

Arguments

disease

character string, disease code (default "DENGUE").

year

numeric, year to produce the graph for (default 2019).

reportParameters

dataframe, dataset including the required parameters for the graph and report production (default AERparams) (see specification of the dataset in the package vignette with browseVignettes(package = "EpiReport"))

index

integer, figure number

pathPNG

character string, full path to the folder containing the maps in PNG (default 'maps' folder included in the package system.file("maps", package = "EpiReport"))

doc

'Word' document (see 'officer' package) in which to add the maps at the bookmark location

pop

character string, label of the type of population to use in the caption (e.g. confirmed)

namePNGsuffix

character string, suffix of the PNG file name of the map (i.e. "COUNT", "RATE" or "AGESTANDARDISED".)

unit

character string, label of the unit used in the caption (e.g. "per 100 000 population")

mapBookmark

character string, label of the bookmark where to add the map in the 'Word' document

captionBookmark

character string, label of the bookmark where to add the caption in the 'Word' document

Value

'Word' doc

See Also

Global function: getMap