+
-
+
-
The miniCRAN package exposes two functions that provide information about dependencies:
-
The function pkgDep() returns a character vector with the names of dependencies. Internally, pkgDep() is a wrapper around tools::package_dependencies(), a base R function that, well, tells you about package dependencies. My pkgDep() function is in one way a convenience, but more importantly it sets different defaults (more about this later).
The function makeDepGraph() creates a graph representation of the dependencies.
-
The package chron neatly illustrates the different roles of Imports, Suggests and Enhances:
-
chron Imports the base packages graphics and stats. This means that chron internally makes use of graphics and stats and will always load these packages.
chron Suggests the packages scales and ggplot2. This means that chron uses some functions from these packages in examples or in its vignettes. However, these functions are not necessary to use chron
chron Suggests the packages scales and ggplot2. This means that chron uses some functions from these packages in examples or in its vignettes. However, these functions are not necessary to use chron
chron Enhances the package zoo, meaning that it adds something to zoo packages. These enhancements are made available to you if you have zoo installed.
-
+
A worked example using the package chron
-
The function pkgDep() exposes not only these dependencies, but also also all recursive dependencies. In other words, it answers the question which packages need to be installed to satsify all dependencies of dependencies.
-
This means that the algorithm is as follows:
-
- First retrieve a list of Suggests and Enhances, using a non-recursive dependency search
- Next, perform a recursive search for all Imports, Depends and LinkingTo
-
The resulting list of packages should then contain the complete list necessary to satisfy all dependencies. In code:
-
-
library("miniCRAN")
-
-
-
tags <- "chron"
-pkgDep(tags, availPkgs = cranJuly2014)
-
-
+
library("miniCRAN")
+
tags <- "chron"
+pkgDep(tags, availPkgs = cranJuly2014)
## [1] "chron" "RColorBrewer" "dichromat" "munsell"
## [5] "plyr" "labeling" "colorspace" "Rcpp"
## [9] "digest" "gtable" "reshape2" "scales"
-## [13] "proto" "MASS" "stringr" "ggplot2"
-
-
-
To create an igraph plot of the dependencies, use the function makeDepGraph() and plot the results:
-
-
dg <- makeDepGraph(tags, enhances=TRUE, availPkgs = cranJuly2014)
-
-
-
## Loading required namespace: igraph
-
-
-
set.seed(1)
-plot(dg, legendPosition = c(-1, 1), vertex.size=20)
-
-
-
-
+## [13] "proto" "MASS" "stringr" "ggplot2"
+
To create an igraph plot of the dependencies, use the function makeDepGraph() and plot the results:
+
dg <- makeDepGraph(tags, enhances=TRUE, availPkgs = cranJuly2014)
+
## Loading required namespace: igraph
+
set.seed(1)
+plot(dg, legendPosition = c(-1, 1), vertex.size=20)
+
Note how the dependencies expand to zoo (enhanced), scales and ggplot (suggested) and then recursively from there to get all the Imports and LinkingTo dependencies.
-
+
+
An example with multiple input packages
-
As a final example, create a dependency graph of seven very popular R packages:
-
-
tags <- c("ggplot2", "data.table", "plyr", "knitr", "shiny", "xts", "lattice")
-pkgDep(tags, suggests = TRUE, enhances=FALSE, availPkgs = cranJuly2014)
-
-
+
tags <- c("ggplot2", "data.table", "plyr", "knitr", "shiny", "xts", "lattice")
+pkgDep(tags, suggests = TRUE, enhances=FALSE, availPkgs = cranJuly2014)
## [1] "ggplot2" "data.table" "plyr" "knitr"
## [5] "shiny" "xts" "lattice" "digest"
## [9] "gtable" "reshape2" "scales" "proto"
@@ -285,16 +133,34 @@ An example with multiple input packages
## [65] "foreach" "doMC" "itertools" "testit"
## [69] "rgl" "XML" "RCurl" "Cairo"
## [73] "timeSeries" "tseries" "its" "fts"
-## [77] "tis" "KernSmooth"
-
-
-
dg <- makeDepGraph(tags, enhances=TRUE, availPkgs = cranJuly2014)
+## [77] "tis" "KernSmooth"
+
dg <- makeDepGraph(tags, enhances=TRUE, availPkgs = cranJuly2014)
set.seed(1)
-plot(dg, legendPosition = c(-1, -1), vertex.size=10, cex=0.7)
-
+plot(dg, legendPosition = c(-1, -1), vertex.size=10, cex=0.7)
+
+
-
-
+
+
+
+
+
+
Start by creating the recursive dependency tree for your target packages.
-
For example, imagine a scenario where you want to create a repository that consists of the package foreach and its dependencies.
-
Start by creating the dependency list:
-
-
library("miniCRAN")
+library("miniCRAN")
# use Revolution Analytics CRAN mirror
-revolution <- c(CRAN="http://cran.revolutionanalytics.com")
+revolution <- c(CRAN="http://cran.microsoft.com")
# Specify list of packages to download
pkgs <- c("foreach")
pkgList <- pkgDep(pkgs, repos=revolution, type="source", suggests = FALSE, availPkgs = cranJuly2014)
-pkgList
-
-
-## [1] "foreach" "codetools" "iterators"
-
-
-Next, create a repository with the function makeRepo(). In this example, get the required files for source packages as well as windows binaries:
-
-# Create temporary folder for miniCRAN
+pkgList
+## [1] "foreach" "codetools" "iterators"
+Next, create a repository with the function makeRepo(). In this example, get the required files for source packages as well as windows binaries:
+# Create temporary folder for miniCRAN
dir.create(pth <- file.path(tempdir(), "miniCRAN"))
# Make repo for source and win.binary
makeRepo(pkgList, path=pth, repos=revolution, type="source")
-makeRepo(pkgList, path=pth, repos=revolution, type="win.binary")
-
-
+makeRepo(pkgList, path=pth, repos=revolution, type="win.binary")
Investigate the repository file structure:
-
-
# List all files in miniCRAN
-list.files(pth, recursive=TRUE, full.names=FALSE)
-
-
+
# List all files in miniCRAN
+list.files(pth, recursive=TRUE, full.names=FALSE)
Use pkgAvail to list available packages in your repository:
-
-
# Check for available packages
-pkgAvail(repos=pth, type="win.binary")[, c(1:3, 5)]
-
-
+
# Check for available packages
+pkgAvail(repos=pth, type="win.binary")[, c(1:3, 5)]
+
Install packages from your local repository
-
To install packages from a local repository, you need to use the URI convention file:/// to point to your file lcoation.
-
-
install.packages(pkgs,
+install.packages(pkgs,
repos = paste0("file:///", pth),
- type = "source")
-
-
+ type = "source")
+
+
Adding packages to an existing miniCRAN repository
-
+
Adding new packages from CRAN
-
After creating a local miniCRAN repository, additional packages and their dependencies can easily be added. This mechanism can also be used to re-add an existing package to the miniCRAN repo.
-
-
# Add new packages (from CRAN) to the miniCRAN repo
-addPackage("Matrix", path=pth, repos=revolution, type="source")
-
-
+
# Add new packages (from CRAN) to the miniCRAN repo
+addPackage("Matrix", path=pth, repos=revolution, type="source")
The value that is returned via addPackage is the number of packages written to the index file, i.e., the total number of packages in the repo of that type.
-
+
+
Adding an older version of a package from CRAN
-
To add a specific version of a package from CRAN (or another CRAN-like repository), we can easily download the source packages from the CRAN archives. Dependencies for old package versions cannot be determined automatically and must be specified by the user.
-
Note: in order to to add binaries of older packages, you will need to download the source and build the binaries on the intended platform yourself. You will need the appropriate R development tools installed in order to build package binaries from source.
-
-
# create a data frame with the package and version info
+# create a data frame with the package and version info
oldVers <- data.frame(package=c("foreach", "codetools", "iterators"),
version=c("1.4.0", "0.2-7", "1.0.5"),
stringsAsFactors=FALSE)
# download old source package version and create repo index
-addOldPackage(pkgList, path=pth, vers=oldVers$version, repos=revolution, type="source")
-
-
-You will get a warning whenever there are multiple versions of a package saved in the repository. Currently, you need to manually remove duplicate versions before rebuilding the repository's package index.
-
+addOldPackage(pkgList, path=pth, vers=oldVers$version, repos=revolution, type="source")
+
You will get a warning whenever there are multiple versions of a package saved in the repository. Currently, you need to manually remove duplicate versions before rebuilding the repository’s package index.
Note: This last step is important, otherwise you may end up with a repo in an inconsistent state.
-
-
# List package versions in the miniCRAN repo (produces warning about duplicates)
+# List package versions in the miniCRAN repo (produces warning about duplicates)
pkgVersionsSrc <- checkVersions(pkgList, path=pth, type="source")
pkgVersionsBin <- checkVersions(pkgList, path=pth, type="win.binary")
@@ -296,35 +145,49 @@ Adding an older version of a package from CRAN
file.remove(pkgVersionsSrc[c(2,4,6)])
# rebuild the package index after removing duplicate package versions
-updateRepoIndex(pth, type=c("source", "win.binary"))
-
-
+updateRepoIndex(pth, type=c("source", "win.binary"))
To see the updated list of packages available in the miniCRAN repo:
-
-
pkgAvail(pth, type="source")[, c(1:3, 5)] # contains the old versions
-pkgAvail(pth, type="win.binary")[, c(1:3, 5)] # contains the current versions
-
-
+
pkgAvail(pth, type="source")[, c(1:3, 5)] # contains the old versions
+pkgAvail(pth, type="win.binary")[, c(1:3, 5)] # contains the current versions
+
+
Adding packages from other sources
-
This feature will be implemented in a future release.
-
+
+
+
Updating the packages in a miniCRAN repository
-
Checking for updated versions of the packages currently stored in the miniCRAN repository:
-
-
# Check if updated packages are available
+# Check if updated packages are available
oldPackages(path=pth, repos=revolution, type="source")[, 1:3] # should need update
-oldPackages(path=pth, repos=revolution, type="win.binary")[, 1:3] # should be current
-
-
+oldPackages(path=pth, repos=revolution, type="win.binary")[, 1:3] # should be current
Update the versions of the packages currently stored in the miniCRAN repository. By default, a prompt is given to confirm the update for each package. This prompt can be suppressed using ask=FALSE, which will update all packages. Be careful using this option if you want to keep certain packages at an older version.
-
-
# Update available packages
+# Update available packages
updatePackages(path=pth, repos=revolution, type="source", ask=FALSE) # should need update
-updatePackages(path=pth, repos=revolution, type="win.binary", ask=FALSE) # should be current
-
+updatePackages(path=pth, repos=revolution, type="win.binary", ask=FALSE) # should be current
+
-
+
+
-
-
-
-
Using repositories other than CRAN with miniCRAN
+
Although the package name miniCRAN seems to indicate you can only use CRAN as a repository, you can in fact use any CRAN-like repository.
-
This vignette contains some examples of how to refer to different package repositories, including CRAN, alternative mirrors of CRAN, R-Forge as well as BioConductor.
-
To make simplify the code to show the salient features, we use a little helper function, index() that is a simple wrapper around available.packages():
-
-
# Wrapper around available.packages ---------------------------------------
-
+# Wrapper around available.packages ---------------------------------------
+
index <- function(url, type="source", filters=NULL, head=5, cols=c("Package", "Version")){
contribUrl <- contrib.url(url, type=type)
p <- available.packages(contribUrl, type=type, filters=filters)
p[1:head, cols]
-}
-
-
+}
+
Using CRAN
-
The URL for the master mirror in Austria:
-
-
CRAN <- "http://cran.r-project.org"
-index(CRAN)
-
-
+
CRAN <- "http://cran.r-project.org"
+index(CRAN)
+
+
Using a different mirror
-
You can also point to any other mirror, for example the stable version hosted by Revolution Analytics:
-
-
revoStable <- "http://packages.revolutionanalytics.com/cran/3.1/stable"
+revoStable <- "http://packages.revolutionanalytics.com/cran/3.1/stable"
index(revoStable)
-
+
revoMirror <- "http://cran.revolutionanalytics.com"
-index(revoMirror)
-
-
+index(revoMirror)
+
+
Using R-forge
-
R-forge has CRAN-like structure:
-
-
rforge <- "http://r-forge.r-project.org"
-index(rforge)
-
-
+
rforge <- "http://r-forge.r-project.org"
+index(rforge)
+
+
Using BioConductor
-
Although BioConductor has a different preferred install mechanism, the underlying repository structure is also CRAN-like:
-
-
bioc <- local({
+bioc <- local({
env <- new.env()
on.exit(rm(env))
evalq(source("http://bioconductor.org/biocLite.R", local=TRUE), env)
biocinstallRepos()
})
-
+
bioc
bioc[grep("BioC", names(bioc))]
+
+
+index(bioc["BioCsoft"])
+
-index(bioc["BioCsoft"])
-
+