Learn R Programming

functionMap

Function Map of an R Package

Extract all function calls from an R package, or a set of R scripts. Create a network of functions that can be then visualized. Can also extract the places of the function definitions and function calls and export them in a 'JSON' file.

Installation

source("https://raw.githubusercontent.com/MangoTheCat/remotes/master/install-github.R")$value("mangothecat/functionMap")

Usage

library(functionMap)

Use the map_r_script to map a single R script, map_r_folder to recursively map a folder of R files, or map_r_package to map an R package.

All three functions return a function_map object, that can be printed, exported and visualized.

Pretty printing

The default function_map print method lists the function calls in a nice form. For packages, exported functions are marked with a star, and calls to other packages are highlighted with a different color.

License

GPL 2 © Mango Solutions

Copy Link

Version

Version

1.0.0

License

GPL-2

Maintainer

Gábor Csárdi

Last Published

February 15th, 2017

Functions in functionMap (1.0.0)

actively_find_funcs

Try harder to find functions that are called

default_r_file_pattern

Default pattern for R files

Add namespace information to a map of an R package

Check if a path is an R package root directory

Alternative to data.frame

create_function_map

Create a function_map object from a parsed result

Dependencies of all functions

Perform a breadth first search (BFS) on a graph

Drop NULL elements from a list

The longest prefix of both lists

extract_if_needed

Extract a package tarball

Check if a list of function names were imported from a package

Extract data about the edges (function calls) in a function map

find_globals_multiple

Find all (non-local) function calls in a function, keep multiple calls

Find calls to external functions

Find all (non-local) function calls in a function

Export a map to a JSON file

edge_data_frame

Extract edge (= function call) metadata from the call graph

find_in_named_list

Find an element within entries of a named list

func_arg_globals

Find the global functions that are used as arguments

funcs_from_exprs

Get functions from a list of expressions

get_funcs_from_r_script

Extract all functions from an R script

Get exported functions from a package, from `NAMESPACE`

Names of all functions in the `base` package

get_global_calls

Get global function calls from a function

functions_called

All functions that called in a package or R script

All functions of a function map of a package or script

Get funcion(s) from a single expression. Usually a single function, but not necessarily.

Convert a function map to a directed graph

Table of imported functions

map_cran_package

Create the map of a CRAN package

Check if an object is in a list

node_data_frame

Extract vertex (= function) metadata from the call graph

Extract data about the functions in a function map

Vertices that cannot be found from the a set of source vertices

Map the function calls for an R script

Map the function calls for a folder of R scripts

Map an R package

Recycle a vector or a data frame (rows)

maybe_s3_method

Predicate to pre-filter possible S3 methods

Parse the `Collate` field of package `DESCRIPTION`

r_package_files

Get all source files of a package, in the right order

remove_base_functions

Remove base function names form a data frame of functions

Topological sort of a graph

Trim leading and trailing whitespace from a character vector

Find all function calls in an R script

Parse one or more folders of R scripts

print.function_map

Print method for a function map object.

Try to find where some called functions live

Evaluate an expression with a package loaded

Remove loops from a graph

unused_functions

Functions that are never used in a package

Reverse dependencies of all functions

Change the direction of each edge to the opposite in a graph

Find the S3 methods of a function, in an environment

Get the name of the package from `DESCRIPTION`

package_collate

`Collate` field from `DESCRIPTION`

Sankey plot of a function map