oldr (version 0.2.3)

report_op_docx: Create a DOCX report document containing RAM-OP survey results

Description

Create a DOCX report document containing RAM-OP survey results

Usage

report_op_docx(
  estimates,
  svy,
  indicators = c("demo", "food", "hunger", "disability", "adl", "mental", "dementia",
    "health", "income", "wash", "anthro", "oedema", "screening", "visual", "misc"),
  filename = paste(tempdir(), "ramOPreport", sep = "/"),
  title = "RAM-OP Report",
  view = FALSE
)

Value

An DOCX in the working directory or if filename is a path, to a specified directory.

Arguments

estimates

A data.frame of RAM-OP results produced by merge_op().

svy

A data.frame collected using the standard RAM-OP questionnaire

indicators

A character vector of indicator names

filename

Filename for output document. Can be specified as a path to a specific directory where to output report document. Defaults to a path to a temporary directory and a filename ramOPreport.

title

Title of report

view

Logical. Open report in current environment? Default is FALSE.

Author

Ernest Guevarra

Examples

classicResults <- estimate_classic(
  x = create_op(testSVY), w = testPSU, replicates = 9
)

probitResults <- estimate_probit(
  x = create_op(testSVY), w = testPSU, replicates = 9
)

resultsDF <- merge_op(x = classicResults, y = probitResults)

report_op_docx(
  svy = testSVY, estimates = resultsDF, indicators = "mental",
  filename = paste(tempdir(), "report", sep = "/")
)