Convert a foodweb to a matrix

Description

This is equivalent to calling get_funmat() on x.

Usage

## S3 method for class 'foodweb'
as.matrix(x, rownames.force = NA, ...)

Arguments

Value

An n*n numeric matrix where n is the number of functions in the foodweb. Each element ⁠[i][j]⁠ will be 1 if function i calls function j, and 0 otherwise.

Convert a foodweb to a tidygraph

Description

This is an S3 method for the generic tidygraph::as_tbl_graph().

Usage

## S3 method for class 'foodweb'
as_tbl_graph(x, ...)

Arguments

Value

A new tidygraph::tbl_graph object.

Filter a function matrix

Description

Filter a function matrix

Usage

filter_matrix(fn_name, fn_mat)

Arguments

Value

A filtered function matrix containing only functions that are direct descendants or antecedents of fn_name.

Create a foodweb

Description

A foodweb object describes the relationship of functions in an environment. It has two components: funmat (function matrix) which encodes the caller/callee relationships (i.e. which functions call which) and graphviz_spec which is a text representation of the graph and is used for the default plotting behaviour.

Usage

foodweb(
  FUN = NULL,
  env = parent.frame(),
  filter = !is.null(FUN),
  as.text = FALSE
)

Arguments

Details

foodweb() looks at the global environment by default. If you want to look at another environment you can either pass a function to the FUN argument of foodweb() or pass an environment to the env argument. If FUN is provided then the value of env is ignored, and the environment of FUN will be used.

Value

If as.text is TRUE, a character vector. Otherwise, a foodweb object as described above.

Examples

# Create some functions to look at
f <- function() 1
g <- function() f()
h <- function() {
  f()
  g()
}
i <- function() {
  f()
  g()
  h()
}
j <- function() j()

x <- foodweb()
x

# You can access the components directly or via getter functions
x$funmat
get_graphviz_spec(x)

# Calculate the foodweb of a function in another package
foodweb(glue::glue)

Create a function caller/callee matrix

Description

Returns a matrix of 0s and 1s with a row and column for each function in an environment, such that if the function on the x-axis calls the function on the y-axis, the element is 1, otherwise 0.

Usage

foodweb_matrix(env = parent.frame())

Arguments

Value

An n x n matrix where n is the number of functions in env.

Utility function to pluralise "edge" or "edges"

Description

Used when generating descriptions of a foodweb.

Usage

foodweb_summarise(x)

Arguments

Value

A character string in the format "x nodes and y edge/s"

Which functions does a function call?

Description

Given an input function fn_name and a list of candidate functions funs_to_match, return a list of all the functions in funs_to_match that appear in the definition of fn_name.

Usage

functions_called_by(fn_name, funs_to_match, where)

Arguments

Value

A character vector listing the functions in funs_to_match that call fn_name.

Extract the function matrix from a foodweb object.

Description

Extract the function matrix from a foodweb object.

Usage

get_funmat(x)

Arguments

Value

x$funmat - a numeric matrix.

Extract the GraphViz specification from a foodweb object.

Description

Extract the GraphViz specification from a foodweb object.

Usage

get_graphviz_spec(x)

Arguments

Value

x$graphviz_spec - a character scalar.

Create a graphviz specification from a function matrix

Description

Given a function matrix created by foodweb_matrix(), convert it into a text specification that can be passed to DiagrammeR::grViz().

Usage

graphviz_spec_from_matrix(funmat)

Arguments

Value

A text string.

See Also

graphviz.org/

Examples

fm <- matrix(c(0, 1, 1, 1, 0, 1, 0, 1, 0), nrow = 3)
colnames(fm) <- rownames(fm) <- c("foo", "bar", "baz")
graphviz_spec_from_matrix(fm)

Is an object a foodweb?

Description

Is an object a foodweb?

Usage

is.foodweb(x)

Arguments

Value

Boolean

Create a new foodweb object

Description

A foodweb object describes the relationship of functions in an environment. It has two components: a funmat (function matrix) which encodes the caller/callee relationships (i.e. which functions call which) and a grviz_spec which is a text representation of the graph and is used for the default plotting behaviour.

Usage

new_foodweb(funmat)

Arguments

Details

This function should not be called directly, use foodweb() instead.

Value

A foodweb.

See Also

foodweb

Plot a foodweb object

Description

Calls DiagrammeR::grViz() on the graphvis_spec element of the foodweb.

Usage

## S3 method for class 'foodweb'
plot(x, ...)

Arguments

Value

An object of class htmlwidget; the output is just that of the underlying call to DiagrammeR::grViz.

Print a foodweb object

Description

Prints the graphvis_spec member of a foodweb object.

Usage

## S3 method for class 'foodweb'
print(x, ...)

Arguments

Value

NULL, only called for the side effect of printing to the console.

Print a foodweb_matrix

Description

Print a foodweb_matrix

Usage

## S3 method for class 'foodweb_matrix'
print(x, ...)

Arguments

Value

x, invisibly