R/testCoverage.R

In MangoTheCat/testCoverage: Analyzing coverage of R unit tests

#' Code coverage test files.
#'
#' \code{testCoverage} computes the code coverage that a unit test suite provides
#' a set of source files.
#'
#' This function is for testing disorganised source files for packages helper 
#' functions are available.
#' 
#' testthat tests are assumed by default, otherwise see 
#' \code{\link{reportCoverage}} for the necessary parameters.
#'
#' @param sourcefiles character vector of source code filenames
#' @param testfiles character vector of unit test filenames
#' @param ... parameters to pass onto reportCoverage
#' @return A list containing summary coverage, errors and individual coverage.
#'  Side effect: A webpage of the report will be opened.
#'
#' @examples
#' \dontrun{
#' testCoverage(
#'  system.file("examples/add/R/add.R", package = "testCoverage"), 
#'  system.file("examples/add/inst/tests/testthat/", 
#'   c("tests0/test_add0.R", "tests1/test_add1.R"), package = "testCoverage"))
#' }
#' @seealso \code{\link{reportCoverage}}, \code{\link{pkgCoverage}}, 
#' \code{\link{cranCoverage}}
#' @author Mango Solutions\email{support@@mango-solutions.com}
#' @export
testCoverage <- function(sourcefiles, testfiles, ...) {
  reportCoverage(sourcefiles = sourcefiles, executionfiles = testfiles, ...)
}