Retrieve Dependency Information for a Vignette

Description

Given a vignette name, will create a DependsList object that reports information about the packages the vignette depends on.

Usage

vignetteDepends(vignette, recursive = TRUE, reduce = TRUE,
                local = TRUE, lib.loc = NULL)

Arguments

Details

If recursive is TRUE, any package that is specified as a dependency will in turn have its dependencies included (and so on), these are known as indirect dependencies. If recursive is FALSE, only the dependencies directly named by the vignette will be used.

If local is TRUE, the system will only look at the user's local machine and not online to find dependencies.

If reduce is TRUE, the system will collapse the fields in the DependsList object such that a minimal set of dependencies are specified (for instance if there was foo, foo (>= 1.0.0), foo (>= 1.3.0, it would only return foo (>= 1.3.0)).

Value

An object of class "DependsList".

Author(s)

Jeff Gentry

See Also

pkgDepends

Examples

## This may not be installed, as it requires lattice
gridEx <- system.file("doc", "grid.Rnw", package = "grid")
vignetteDepends(gridEx)

Results

R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(tools)
> png(filename="/home/ddbj/snapshot/RGM3/R_rel/result/tools/vignetteDepends.Rd_%03d_medium.png", width=480, height=480)
> ### Name: vignetteDepends
> ### Title: Retrieve Dependency Information for a Vignette
> ### Aliases: vignetteDepends
> ### Keywords: utilities
> 
> ### ** Examples
> ## No test: 
> ## This may not be installed, as it requires lattice
> gridEx <- system.file("doc", "grid.Rnw", package = "grid")
> vignetteDepends(gridEx)
$Depends
[1] "lattice"

$Installed
[1] "lattice"

$Found
list()

$NotFound
character(0)

$R
[1] "R (>= 3.0.0)"

attr(,"class")
[1] "DependsList"
Warning messages:
1: 'getDepList' is deprecated.
Use 'dependsOnPkgs() or package_dependencies()' instead.
See help("Deprecated") 
2: 'package.dependencies' is deprecated.
Use 'package_dependencies' instead.
See help("Deprecated") 
> ## End(No test)
> 
> 
> 
> 
> dev.off()
null device 
          1 
>