report_op_html: Create an HTML report document containing RAM-OP survey...

View source: R/10-report.R

report_op_htmlR Documentation

Create an HTML report document containing RAM-OP survey results

Description

Create an HTML report document containing RAM-OP survey results

Usage

report_op_html(
  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
)

Arguments

estimates

A data.frame of RAM-OP results produced by merge_estimates function.

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 browser? Default is FALSE.

Value

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

Author(s)

Ernest Guevarra

Examples

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

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

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

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


rapidsurveys/oldr documentation built on April 15, 2024, 11:18 a.m.