R/build_report.R

In prpatil/tdsm: Templated Deterministic Statistical Machines

#'
#' Generate a knitr report for a specified analysis
#'
#' @param path Character vector specifying the path of a duplicated analysis template, should the user choose to use this instead
#' @param data A list object containing all relevant data elements. Specific attributes are defined in the details.
#' @param title A character string setting the report title. Default "Example".
#' @param seed A random seed set at the beginning of the report. Default 47209
#'
#' @export
#'
#' @details This is a generic function that passes a data object to an analysis template
#' of the user's choosing. The template checks the data object to ensure compatibility.
#' 
#'
#' @return An object, as specified in the description of the chosen analysis

build_report <- function(path, data, title="Example", seed=47209){
	
	filename <- file.choose()
	
	render(path, output_format="knitrBootstrap::bootstrap_document",output_file=filename)

	return_elements
}