biocroxytest

Handle Long Tests in Bioconductor Packages


Bioconductor version: Release (3.19)

This package provides a roclet for roxygen2 that identifies and processes code blocks in your documentation marked with `@longtests`. These blocks should contain tests that take a long time to run and thus cannot be included in the regular test suite of the package. When you run `roxygen2::roxygenise` with the `longtests_roclet`, it will extract these long tests from your documentation and save them in a separate directory. This allows you to run these long tests separately from the rest of your tests, for example, on a continuous integration server that is set up to run long tests.

Author: Francesc Catala-Moll [aut, cre]

Maintainer: Francesc Catala-Moll <fcatala at irsicaixa.es>

Citation (from within R, enter citation("biocroxytest")):

Installation

To install this package, start R (version "4.4") and enter:


if (!require("BiocManager", quietly = TRUE))
    install.packages("BiocManager")

BiocManager::install("biocroxytest")

For older versions of R, please refer to the appropriate Bioconductor release.

Documentation

To view documentation for the version of this package installed in your system, start R and enter:

browseVignettes("biocroxytest")
Introduction to biocroxytest HTML R Script
Reference Manual PDF
NEWS Text

Details

biocViews Infrastructure, Software
Version 1.0.0
In Bioconductor since BioC 3.19 (R-4.4) (< 6 months)
License GPL (>= 3)
Depends R (>= 4.4.0)
Imports cli, glue, roxygen2, stringr
System Requirements
URL https://github.com/xec-cm/biocroxytest
Bug Reports https://github.com/xec-cm/biocroxytest/issues
See More
Suggests BiocStyle, here, knitr, rmarkdown, testthat (>= 3.0.0)
Linking To
Enhances
Depends On Me
Imports Me
Suggests Me
Links To Me
Build Report Build Report

Package Archives

Follow Installation instructions to use this package in your R session.

Source Package biocroxytest_1.0.0.tar.gz
Windows Binary biocroxytest_1.0.0.zip
macOS Binary (x86_64) biocroxytest_1.0.0.tgz
macOS Binary (arm64) biocroxytest_1.0.0.tgz
Source Repository git clone https://git.bioconductor.org/packages/biocroxytest
Source Repository (Developer Access) git clone git@git.bioconductor.org:packages/biocroxytest
Bioc Package Browser https://code.bioconductor.org/browse/biocroxytest/
Package Short Url https://bioconductor.org/packages/biocroxytest/
Package Downloads Report Download Stats