R/make.taf.R

In ices-tools-prod/TAF: Transparent Assessment Framework for Reproducible Research

#' Run TAF Script if Needed
#'
#' Run a TAF script if the target directory is either older than the script, or
#' older than the directory of the previous TAF step.
#'
#' @param script TAF script filename.
#' @param \dots passed to \code{\link{make}} and \code{\link{source.taf}}.
#'
#' @return \code{TRUE} or \code{FALSE}, indicating whether the script was run.
#'
#' @note
#' Any underlying scripts are automatically included if they share the same
#' filename prefix, followed by an underscore. For example, when determining
#' whether a script \verb{data.R} should be run, this function checks whether
#' \verb{data_foo.R} and \verb{data_bar.R} have been recently modified.
#'
#' @seealso
#' \code{\link{source}} runs any R script, \code{\link{source.taf}} is more
#' convenient for running a TAF script, and \code{\link{source.all}} runs all
#' TAF scripts.
#'
#' \code{\link{make}}, \code{\link{make.taf}}, and \code{\link{make.all}} are
#' similar to the \code{source} functions, except they avoid repeating tasks
#' that have already been run.
#'
#' \code{\link{TAF-package}} gives an overview of the package.
#'
#' @examples
#' \dontrun{
#' make.taf("model.R")
#' }
#'
#' @aliases makeTAF
#'
#' @export

make.taf <- function(script, ...)
{
  script <- basename(script)
  out <- switch(script,
                utilities.R=source.taf("utilities.R"),
                data.R=make("data.R",
                            dir(pattern="^data_.*\\.R$"),
                            "data", engine=source.taf, ...),
                method.R=make("method.R",
                              c("data",dir(pattern="^method_.*\\.R$")),
                              "method", engine=source.taf, ...),
                model.R=make("model.R",
                             c("data",dir(pattern="^model_.*\\.R$")),
                             "model", engine=source.taf, ...),
                output.R=make("output.R",
                              c(model.dir(),dir(pattern="^output_.*\\.R$")),
                              "output", engine=source.taf, ...),
                report.R=make("report.R",
                              c("output",dir(pattern="^report_.*\\.R$")),
                              "report", engine=source.taf, ...),
                FALSE)
  invisible(out)
}

#' @export

## Equivalent spelling

makeTAF <- function(...)
{
  make.taf(...)
}