pkgnet

WARNING: This package is still under construction. It’s API can and will change. Please contribute to the conversation about its future by submitting issues and pull requests, or by contacting the package maintainer (see the DESCRIPTION file) directly.

Introduction

pkgnet is an R library designed for the analysis of R libraries! The goal of the package is to build a graph representation of a package and its dependencies to inform a variety of activities, including:

• prioritizing functions to unit test based on their centrality
• examining the recursive depdencies you are taking on by using a given package
• exploring the structure of a new package provided by a coworker or downloaded from the internet

Table of contents

1. How it Works
2. Installation
3. Usage Examples
4. How to Contribute
5. Next Steps

How it Works

The core functionality of this package is the CreatePackageReport function.

Installation

This package has not yet been submitted to CRAN, though we intend to do so soon.

To use the development version of the package, you can install directly from GitHub

devtools::install_github("UptakeOpenSource/pkgnet")

Usage Examples

Try it out!

library(pkgnet)
result <- CreatePackageReport('ggplot2')

How to Contribute

To report bugs, request features, or ask questions about the structure of the code, please open an issue.

If you’d like to contribute to the project, please open a pull request. PRs should follow the project’s contribution guidelines.

Next Steps

This is a fairly new project and, as the version number indicates, should be regarded as a work in progress.