https://github.com/uptake/pkgnet

R package for analyzing other R packages via graph representations of their dependencies
https://github.com/uptake/pkgnet

code-quality dependency-analysis dependency-graph graph-theory r r-package

Last synced: about 1 month ago
JSON representation

R package for analyzing other R packages via graph representations of their dependencies

• Host: GitHub
• URL: https://github.com/uptake/pkgnet
• Owner: uptake
• License: other
• Created: 2017-10-09T04:40:13.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-07-01T15:13:36.000Z (3 months ago)
• Last Synced: 2024-07-18T08:12:17.754Z (2 months ago)
• Topics: code-quality, dependency-analysis, dependency-graph, graph-theory, r, r-package
• Language: R
• Homepage: https://uptake.github.io/pkgnet/
• Size: 5.82 MB
• Stars: 150
• Watchers: 3
• Forks: 37
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• jimsghstars - uptake/pkgnet - R package for analyzing other R packages via graph representations of their dependencies (R)

README

        
# pkgnet 

[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version-last-release/pkgnet)](https://cran.r-project.org/package=pkgnet) 

[![CRAN\_Download\_Badge](https://cranlogs.r-pkg.org/badges/grand-total/pkgnet)](https://cran.r-project.org/package=pkgnet) 

[![GitHub Actions Build Status](https://github.com/uptake/pkgnet/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/uptake/pkgnet/actions/workflows/ci.yml?query=branch%3Amain)

[![Appveyor Build status](https://ci.appveyor.com/api/projects/status/github/uptake/pkgnet?branch=main&svg=true)](https://ci.appveyor.com/project/jameslamb/pkgnet)

[![codecov](https://codecov.io/gh/uptake/pkgnet/branch/main/graph/badge.svg)](https://app.codecov.io/gh/uptake/pkgnet) 

[![Lifecycle badge](https://lifecycle.r-lib.org/articles/figures/lifecycle-stable.svg)](https://lifecycle.r-lib.org/articles/stages.html)

## 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 dependencies 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

![](https://raw.githubusercontent.com/uptake/pkgnet/main/readme_figures/demo.gif)

# Table of contents

1. [How it Works](#howitworks)

2. [Installation](#installation)

3. [Usage Examples](#examples)

4. [How to Contribute](#contributing)

## How it Works 

The core functionality of this package is the `CreatePackageReport` function.

## Installation 

This package is now available from [CRAN](https://cran.r-project.org/package=pkgnet)!

```

install.packages('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](https://github.com/uptake/pkgnet/issues).

If you'd like to contribute to the project, please [open a pull request](https://github.com/uptake/pkgnet/pulls). PRs should follow the project's [contribution guidelines](https://github.com/uptake/pkgnet/blob/main/CONTRIBUTING.md).