create_report {dbGaPCheckup}

Create Report

Description

This function calls eval_function to generate a textual and graphical report of the selected variables in HTML format, and optionally opens it in the web browser.

Usage

create_report(
  DD.dict,
  DS.data,
  sex.split = FALSE,
  sex.name = NULL,
  start = 1,
  end = 1,
  non.NA.missing.codes = NA,
  output.path = tempdir(),
  open.html = TRUE,
  fn.stem = "Report"
)

Arguments

DD.dict

Data dictionary.

DS.data

Data set.

sex.split

When TRUE, split reports by the field named as defined by the sex.name variable.

sex.name

Character string specifying the name of the sex field.

start

Staring index of the first select trait.

end

Ending index of the last selected trait.

non.NA.missing.codes

A user-defined vector of numerical missing value codes (e.g., -9999).

output.path

Path to the folder in which to create the HTML report document.

open.html

If TRUE, open the HTML report document in the web browser.

fn.stem

File name stem.

Value

Full path to the HTML report document.

Examples

data(ExampleB)
create_report(DD.dict.B, DS.data.B, sex.split=TRUE, sex.name= "SEX",
   start = 3, end = 7, non.NA.missing.codes=c(-9999,-4444),
   output.path= tempdir(), open.html = FALSE)