File: BiocManager-pkg.Rd

package info (click to toggle)
r-cran-biocmanager 1.30.10%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 284 kB
  • sloc: sh: 13; makefile: 2
file content (66 lines) | stat: -rw-r--r-- 2,049 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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/BiocManager-pkg.R
\docType{package}
\name{BiocManager-pkg}
\alias{BiocManager-pkg}
\alias{_PACKAGE}
\alias{BiocManager}
\alias{BiocManager-pkg-package}
\title{Install or update Bioconductor, CRAN, or GitHub packages}
\description{
This package provides tools for managing \emph{Bioconductor} and other
packages in a manner consistent with \emph{Bioconductor}'s package
versioning and release system.
}
\details{
Main functions are as follows; additional help is
available for each function, e.g., \code{?BiocManager::version}.

\describe{

\item{\code{BiocManager::install()}}{Install or update packages from
\emph{Bioconductor}, CRAN, and GitHub.}

\item{\code{BiocManager::version()}}{Report the version of
\emph{Bioconductor} in use.}

\item{\code{BiocManager::available()}}{Return a \code{character()} vector
of package names available (at \code{BiocManager::repositories()})
for installation.}

\item{\code{BiocManager::valid()}}{Determine whether installed packages
are from the same version of \emph{Bioconductor}.}

\item{\code{BiocManager::repositories()}}{\emph{Bioconductor} and other
repository URLs to discover packages for installation.}

}\preformatted{The version of _Bioconductor_ in use is determined by the
installed version of a second package, BiocVersion. BiocVersion
is installed automatically during first use of
`BiocManager::install()`. If BiocVersion has not yet been
installed, the version is determined by code in base R.
}
}
\examples{
R.version.string
packageVersion("BiocManager")
if ("BiocVersion" \%in\% rownames(installed.packages()))
    packageVersion("BiocVersion")
BiocManager::version()
}
\seealso{
Useful links:
\itemize{
  \item Report bugs at \url{https://github.com/Bioconductor/BiocManager/issues}
}

}
\author{
\strong{Maintainer}: Marcel Ramos \email{marcel.ramos@roswellpark.org} (0000-0002-3242-0582) [contributor]

Authors:
\itemize{
  \item Martin Morgan \email{martin.morgan@roswellpark.org} (0000-0002-5874-8148)
}

}