cytoverse_update_check: Check available updates for all cytoverse packages

Description Usage Arguments Value Examples

View source: R/update.R

Description

Check available updates for all cytoverse packages

Usage

1
cytoverse_update_check(repo = "bioconductor", pkgs = NULL, branch = NULL)

Arguments

repo

either "bioconductor" or "github", specifying repository source

pkgs

A character vector containing a specific subset of cytoverse packages to check for updates. If NULL, all cytoverse packages will be checked. For the full list of packages, see cytoverse_packages.

branch

optionally allows specification of a branch within the repository. For Bioconductor, this corresponds to the version (e.g. "3.11" or "devel") and will default to the value of BiocManager::version(). For GitHub, this refers to branch from the GitHub repositories and will default to "master".

Value

a length-2 list containing a dataframe summarizing the installed and available package versions and a vector of package names to be updated

Examples

1
2
3
4
5
6
7
## Not run: 
# Defaults to Bioconductor
check_results <- cytoverse_update_check()
check_results$summary
check_results$lto_update

## End(Not run)

RGLab/cytoverse documentation built on July 17, 2020, 11:38 p.m.