create_report: Create a report

In martingerdin/reporter: Compile a Data Review Report

Description

Creates a data report using a codebook and dataset. The codebook and dataset have to be aligned so that the codebook describes the content of the dataset.

Usage

create_report(codebook, dataset, strata = NULL, write = FALSE)

Arguments

codebook	List of class reporter:codebook or character. A character vector of length 1 is assumed to be the codebook file path and is passed to import_codebook(). No default.
dataset	Dataframe of class reporter:dataset or character. A character vector of length 1 is assumed to be the dataset file path and is passed to import_dataset(). No default.
strata	Character or NULL. The name of the variable to use for stratification. The report will not be stratified if strata is NULL. Defaults to NULL.
write	Logical. If TRUE the report is written to disk using write_report(). If FALSE the report is only returned. Defaults to FALSE.

Value

A report, which is a list of report components that can be written to disk using write_report() or using create_report(.., write = TRUE)

Examples

create_report()

martingerdin/reporter documentation built on Aug. 28, 2020, 12:05 a.m.