README.md

functionMap

Function Map of an R Package

Project Status: WIP - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Linux Build Status Windows Build status CRAN RStudio mirror downloads Coverage Status

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



MangoTheCat/functionMap documentation built on May 7, 2019, 2:10 p.m.