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 67 68 69
|
#' @importFrom utils packageVersion contrib.url head
#' installed.packages sessionInfo tail
NULL
#' Install or update Bioconductor, CRAN, or GitHub packages
#'
#' This package provides tools for managing _Bioconductor_ and other
#' packages in a manner consistent with _Bioconductor_'s package
#' versioning and release system.
#'
#' @details
#'
#' Main functions are as follows; additional help is available for
#' each function, e.g., `?BiocManager::version`.
#'
#' - `BiocManager::install()`: Install or update packages from
#' _Bioconductor_, CRAN, and GitHub.
#'
#' - `BiocManager::version()`: Report the version of _Bioconductor_ in
#' use.
#'
#' - `BiocManager::available()`: Return a `character()` vector of
#' package names available (at `BiocManager::repositories()`) for
#' installation.
#'
#' - `BiocManager::valid()`: Determine whether installed packages are
#' from the same version of _Bioconductor_.
#'
#' - `BiocManager::repositories()`: _Bioconductor_ and other
#' repository URLs to discover packages for installation.
#'
#' 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.
#'
#' Options influencing package behavior (see `?options`, `?getOption`)
#' include:
#'
#' - `"repos"`, `"BiocManager.check_repositories"`,
#' `"BiocManager.snapshot"`: URLs of additional repositories for use
#' by `BiocManger::install()`. See `?repositories`.
#'
#' - `"pkgType"`: The default type of packages to be downloaded and
#' installed; see `?install.packages`.
#'
#' - `"timeout"`: The maximum time allowed for download of a single
#' package, in seconds. _BiocManager_ increases this to 300 seconds
#' to accommodate download of large BSgenome and other packages.
#'
#' System environment variables influencing package behavior include:
#'
#' - \env{BIOCONDUCTOR_ONLINE_VERSION_DIAGNOSIS} advanced
#' configuration to avoid _Bioconductor_ version checks. See
#' `?install`.
#'
#' @md
#' @name BiocManager-pkg
#' @aliases BiocManager
#' @docType package
#'
#' @examples
#' R.version.string
#' packageVersion("BiocManager")
#' if (requireNamespace("BiocVersion", quietly = TRUE))
#' packageVersion("BiocVersion")
#' BiocManager::version()
"_PACKAGE"
|