R/cobaltr_self_test.R

Defines functions cobaltr_self_test

Documented in cobaltr_self_test

#' Self-test the package
#' @inheritParams default_params_doc
#' @examples
#' if (is_cobalt_installed()) {
#'   cobaltr_self_test()
#' }
#' @author Richèl J.C. Bilderbeek
#' @export
cobaltr_self_test <- function(
  cobalt_options = create_cobalt_options(),
  cobalt_folder = get_default_cobalt_folder()
) {
  cobaltr::run_cobalt(
    fasta_filename = system.file(
      "extdata", "example.fasta", package = "cobaltr"
    ),
    cobalt_options = cobalt_options,
    cobalt_folder = cobalt_folder
  )
  invisible(NULL)
}
richelbilderbeek/cobaltr documentation built on March 29, 2024, 7:46 a.m.