knitr::opts_chunk$set(error=FALSE, warning=FALSE, message=FALSE) library(basilisk.utils) library(BiocStyle)
This document and package is strictly for the developers of
If you are a developer of a client package, you probably want to read the
r Biocpkg("basilisk") vignette instead.
If you are an end-user of some client package, you are better off reading the documentation for that client instead.
This package centralizes various R functions that are required for installing
By default, these functions are (potentially) called in
basiliskStart() during client run-time.
However, under certain conditions, they are called via the
configure file during
r Biocpkg("basilisk") installation.
Ideally, we would put these functions inside
r Biocpkg("basilisk") for use in all situations.
However, this is not possible as
configure runs before installation, i.e., before any functions are actually available!
The naive option is to simply duplicate the code in both the package and
this is unappealing as it requires us to maintain twice as much code and circumvents
R CMD check's code quality checks.
r Biocpkg("basilisk.utils") package provides R functions that can be called in both
This allows us to avoid code duplication and enjoy the safety of
R CMD check.
The consequence of this approach is that
r Biocpkg("basilisk.utils") has no direct relevance to other packages or end-users,
and thus should never be explicitly loaded into a package namespace or R session.
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.