https://github.com/ARawles/packageR

An R package to inspect R packages
https://github.com/ARawles/packageR

developer-tools development r

Last synced: 2 months ago
JSON representation

An R package to inspect R packages

• Host: GitHub
• URL: https://github.com/ARawles/packageR
• Owner: ARawles
• Created: 2020-07-19T11:10:10.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-19T15:54:45.000Z (over 4 years ago)
• Last Synced: 2024-08-13T07:14:05.183Z (6 months ago)
• Topics: developer-tools, development, r
• Language: R
• Homepage: http://packager.arawles.co.uk/
• Size: 108 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md

Awesome Lists containing this project

• jimsghstars - ARawles/packageR - An R package to inspect R packages (R)

README

        
---

output: github_document

---

```{r setup, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%")

devtools::load_all()

```

# PackageR 

The goal of PackageR is to to help users better understand their package. When developing R packages, it's easy to lose track of the scale of the project. This package provides functions to give developers a better insight into the number of functions, files, and their length. From here, developers can work to identify overly-complex functions or chokepoints and eventually write cleaner code.

## Installation

You can install the development version from [GitHub](https://github.com/ARawles/PackageR) with:

``` r

# install.packages("devtools")

devtools::install_github("ARawles/packageR")

```

## Example

To get a high-level understanding of the functions and files in your package, use the `plot_` functions. These functions will produce ggplot2 graphics showing you a bit more about your package:

```{r}

plot_function_length()

```

To access the data in a more raw format, use the `list_functions()` and `list_x_files()` functions:

```{r}

list_functions()

list_r_files()

```

By setting the `info` parameter to TRUE, you can retrieve more information about the functions:

```{r}

list_functions(info = TRUE)[[1]]

```