Package Recipe 'bioconductor-biocroxytest'

recipe bioconductor-biocroxytest

Handle Long Tests in Bioconductor Packages

Homepage:: https://bioconductor.org/packages/3.20/bioc/html/biocroxytest.html
License:: GPL (>= 3)
Recipe:: /bioconductor-biocroxytest/meta.yaml

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.

package bioconductor-biocroxytest¶

Versions:

1.6.0-0, 1.2.0-0

Depends:

on r-base >=4.5,<4.6.0a0
on r-cli
on r-glue
on r-roxygen2
on r-stringr

Additional platforms:

Installation¶

You need a conda-compatible package manager (currently either pixi, conda, or micromamba) and the Bioconda channel already activated (see Usage). Below, we show how to install with either pixi or conda (for micromamba and mamba, commands are essentially the same as with conda).

Pixi¶

With pixi installed and the Bioconda channel set up (see Usage), to install globally, run:

pixi global install bioconductor-biocroxytest

to add into an existing workspace instead, run:

pixi add bioconductor-biocroxytest

In the latter case, make sure to first add bioconda and conda-forge to the channels considered by the workspace:

pixi workspace channel add conda-forge
pixi workspace channel add bioconda

Conda¶

With conda installed and the Bioconda channel set up (see Usage), to install into an existing and activated environment, run:

conda install bioconductor-biocroxytest

Alternatively, to install into a new environment, run:

conda create -n envname bioconductor-biocroxytest

with envname being the name of the desired environment.

Container¶

Alternatively, every Bioconda package is available as a container image for usage with your preferred container runtime. For e.g. docker, run:

docker pull quay.io/biocontainers/bioconductor-biocroxytest:<tag>

(see bioconductor-biocroxytest/tags for valid values for <tag>).

Integrated deployment¶

Finally, note that many scientific workflow management systems directly integrate both conda and container based software deployment. Thus, workflow steps can be often directly annotated to use the package, leading to automatic deployment by the respective workflow management system, thereby improving reproducibility and transparency. Check the documentation of your workflow management system to find out about the integration.

Download stats¶

Link to this page¶

Render an badge with the following MarkDown:

[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/bioconductor-biocroxytest/README.html)