[Bioc-devel] How to declare optional system requirement for package

[Alex Wong]

Hi there,

I am the author of SpliceWiz. My package contains several wrapper functions
that run the STAR aligner on systems where it is installed. If STAR is not
found, these functions do nothing other than return a helpful message that
says STAR is not available. The vast majority of the functions in the
package does not depend on STAR, thus STAR is a highly optional requirement
for my package.

What is the best way to convey this in the DESCRIPTION file? Is it
acceptable to add the following line?

> SystemRequirements: STAR (optional)

Kind Regards,

Alex

-- 

*Alex Wong BSc(Med)/MBBS FRACP FRCPA PhD*
Research Officer, Gene and Stem Cell Therapy Program, Centenary Institute

-- 
 <https://www.centenary.org.au>

	[[alternative HTML version deleted]]