R/write_pcl_to_csv.R

Defines functions write_pcl_to_csv

Documented in write_pcl_to_csv

#' Writes csc metrics and output variables to .csv
#'
#' \code{write_pcl_to_csv} writes csc metrics and varialbes to .csv format
#'
#' This is a specific function that writes the output variables to disk in .csv format
#' and runs within the functions \code{process_pcl}, \code{process_multi_pcl}, and
#' \code{proces_tls}.
#'
#'
#' @param output.variables list of concatenated output variables
#' @param outputname name of file currently being processed
#' @param output_directory directory where output goes
#' @keywords output variables
#' @export
#' @seealso
#' \code{\link{process_pcl}}
#' \code{\link{write_summary_matrix_to_csv}}
#' \code{\link{write_hit_matrix_to_csv}}

#' @examples
#' \dontrun{
#' write_pcl_to_csv(output_variables, outputname, output_directory)
#' }
#'
write_pcl_to_csv <- function(output.variables, outputname, output_directory) {

  filename2 <- paste(outputname, ".csv", sep="")
  utils::write.csv(output.variables, file.path(output_directory, filename2))
}
atkinsjeff/forestr documentation built on March 23, 2018, 1:25 a.m.