banff_launcher {banffIT}

Launch the program

Description

This function takes a path string identifying the input file path. The function internally runs a series of tests that assess the input dataset. If any of these tests fails, the user gets information allowing them to correct the input dataset and rerun the process. Once all tests pass, the dataset is given as an output with a diagnosis for each observation (using the function add_diagnoses() internally). The output dataset, along with its associated labels (label:en by default) are provided to the user in an Excel format file accessible in the output_folder specified. The output dataset comes with a report that summarizes information about variable distributions and descriptive statistics.

Usage

banff_launcher(
  input_file,
  output_folder,
  language = "label:en",
  option_filter,
  detail = FALSE
)

Arguments

input_file

A character string identifying the path of the input file (must be a CSV or a one sheet Excel file) to be processed.

output_folder

A character string identifying the folder path where the output files will be saved.

language

Optional argument allowing the user to get the diagnoses in a specific language. Options are "label:en" (default), "label:fr", "label:de", "label:sp", "label:nl", "label:jp", "label:in".

option_filter

Optional argument allowing the user to filter the dataset using dplyr::filter() syntax. The variable used to filter must exist.

detail

Optional argument indicating whether the output should include temporary variables generated in the process or not. FALSE by default.

Value

Nothing to be returned. The function generates a folder (if not already existing) where Excel files are stored.

Examples

{

input_file <- system.file("extdata", "banff_template.xlsx", package = "banffIT")
banff_launcher(input_file, output_folder = tempdir())

}