R/make.data.review.report.r

In martingerdin/beehive: Beehive

#' make data review report
#'
#' this function compiles a data review report
#' @param path path to directory with records, no default
#' @param report_name name of the report file, no default
#' @param report_title title of the data review report, no default
#' @param data_path path to data directory, no default
#' @param data_copy_path path to data copy directory, no default
#' @param dataset_name_prefix a character string to prefix the datasets with, no default
#' @param codebook_path path to codebook, no default
#' @param codebook_name name of codebook, no default
#' @param exclusion_criteria a list of functions defining what observations to exclude from the report, no default 
#' @param test logical, if TRUE the generated report is named test, defaults to FALSE
#' @export
## * content
## ** declare
make.data.review.report <- function(
                                    path,
                                    report_name,
                                    report_title,
                                    data_path,
                                    data_copy_path,
                                    dataset_name_prefix,
                                    codebook_path,
                                    codebook_name,
                                    exclusion_criteria,
                                    test = FALSE
                                    )
{
## ** run initiate function
### loads required packages, sources all function from scripts and sets
### variables to be used by multiple functions throughout the session
    initiate(data_path,
             data_copy_path,
             codebook_path,
             codebook_name)
## ** copy data
### copies all records from path to a local directory so that subsequent
### functions do not have to access path
    copy.data(path)
## ** compile dataset     
### creates centre specific and collated datasets and saves those to disk
    dataset <- compile.collated.dataset(dataset_name_prefix, save = TRUE)
## ** create report    
    create.report(report_title, dataset, report_name, test, exclusion_criteria)
## ** create injury coding review sets
    CreateInjuryCodingReviewSet(dataset)
## * end    
}