File: checkInstalled.Rd

package info (click to toggle)
r-bioc-biocbaseutils 1.8.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 196 kB
  • sloc: makefile: 2
file content (31 lines) | stat: -rw-r--r-- 911 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/checkInstalled.R
\name{checkInstalled}
\alias{checkInstalled}
\title{Check packages are installed otherwise suggest}
\usage{
checkInstalled(pkgs)
}
\arguments{
\item{pkgs}{\code{character()} package names required for a function}
}
\value{
\code{TRUE} if all packages are installed, otherwise stops with a message
and suggests installation of missing packages
}
\description{
\code{checkInstalled} allows to check if a package is installed. If the package is
not available, a convenient copy-and-paste message is provided for package
installation with \code{BiocManager}. The function is typically used within
functions that check for package availability from the \code{Suggests} field.
}
\examples{
if (interactive()) {
    checkInstalled(
        c("BiocParallel", "SummarizedExperiment")
    )
}
}
\author{
M. Morgan, M. Ramos
}