Package 'pkggraph'

Get igraph object from a dataframe representing package dependencies

Description

Packages dependencies (typically obtained from get_dependencies() or get_neighborhood()) is converted into a igraph object.

Usage

as_graph(dependency_df)

Arguments

dependency_df

(dataframe) Representing package dependencies

Value

igraph object

Examples

## Not run: 
init()
as_graph(get_neighborhood("mlr3"))

## End(Not run)

---

Get (reverse) dependencies of a set of packages

Description

Get (reverse) dependencies of a set of packages till a certain depth(level) for a set of dependency types (relation).

Usage

get_dependencies(
  packages,
  level = 1L,
  relation = c("Depends", "Imports", "LinkingTo", "Suggests", "Enhances"),
  strict = FALSE,
  ignore = c("datasets", "utils", "grDevices", "graphics", "stats", "methods"),
  reverse = FALSE
)

Arguments

packages	(chr) Package names
level	(count(1)) Depth of recursive dependency
relation	(chr) Types of relations. Must be a subset of c("Depends", "Imports", "LinkingTo", "Suggests", "Enhances")
strict	(flag[T]) Whether to consider all packages (alternately only 'relation' specific packages) when computing dependencies for the next level.
ignore	(chr) package names to ignore.
reverse	(flag[F]) Whether to get reverse dependencies.

Value

(dataframe) with three columns: pkg_1, relation and pkg_2

See Also

get_neighborhood

Examples

## Not run: 
init()
get_dependencies("mlr3") |>
get_dependencies("mlr3", level = 2)
get_dependencies("mlr3", level = 2, reverse = TRUE)
get_dependencies("mlr3", level = 2, relation = "Imports")
# setting strict to TRUE to only consider 'Imports' of the previous level
get_dependencies("mlr3",
                 level    = 2,
                 relation = "Imports",
                 strict   = TRUE
                 )

## End(Not run)

---

Obtain dependencies and reverse dependencies of a set of packages

Description

Obtain dependencies and reverse dependencies of packages till a given depth (level) for a set of dependency types (relation).

Usage

get_neighborhood(
  packages,
  level = 1L,
  relation = c("Depends", "Imports", "LinkingTo", "Suggests", "Enhances"),
  strict = FALSE,
  ignore = c("datasets", "utils", "grDevices", "graphics", "stats", "methods")
)

Arguments

packages	(chr) Package names
level	(count[1]) Depth of recursive dependency
relation	(chr) Types of relations. Must be a subset of c("Depends", "Imports", "LinkingTo", "Suggests", "Enhances")
strict	(flag[T]) Whether to consider all packages (alternately only 'relation' specific packages) when computing dependencies for the next level
ignore	(chr) Package names to ignore.

Value

(dataframe) three columns: pkg_1, relation and pkg_2

See Also

get_dependencies

Examples

## Not run: 
init()
# explore first level dependencies
get_neighborhood("mlr3")

# explore second level dependencies
get_neighborhood("caret", level = 2)

# explore first level dependencies of multiple packages
# and consider second level dependencies
get_neighborhood(c("caret", "mlr"))

# get 'imports' specific neighborhood of 'mlr'
get_neighborhood("mlr", relation = "Imports")

## End(Not run)

---

Create package metadata and dependency dataframes

Description

Initiate the package by loading the data into parent frame. This should be done as soon as the package is loaded or attached. This creates(rewrites) new variables deptable and packmeta to the environment where it is run from.

Usage

init(repository = "CRAN", ...)

Arguments

repository	(chr[1], Default: "CRAN") One among c("CRAN", "BioCsoft", "BioCann", "BioCexp", "BioCextra", "omegahat"). To use a repository not in this list, set 'repository' to NULL and pass named argument called 'repos' with a valid repository address. This will be passed as is to utils::available.packages().
...	Parameters to be passed to utils::available.packages()

Details

Format of packmeta: A dataframe with one row per package with some metadata.

Format of deptable: Dataframe with three columns pkg_1 (chr), relation (factor, levels = Depends, Imports, Suggests, LinkingTo, Enhances), pkg_2 (chr)

Value

TRUE (invisibly)

---

Static plot of package dependencies

Description

Plot of packages dependencies or neighborhood with edges colored by relation and node sized by 'centrality' from a neighborhood_graph obtained from as_graph.

Usage

## S3 method for class 'neighborhood_graph'
plot(x, layout = "sugiyama", ...)

Arguments

x	neighborhood_graph
layout	layout is passed to ggraph::ggraph
...	Not used

Value

ggraph plot

Examples

## Not run: 
init()
get_neighborhood("mboost") |>
  as_graph() |>
  plot()

## End(Not run)

---