https://github.com/ropensci-archive/pkginspector

:no_entry: ARCHIVED :no_entry: Package review tools
https://github.com/ropensci-archive/pkginspector

r r-package rstats unconf unconf18

Last synced: 3 months ago
JSON representation

:no_entry: ARCHIVED :no_entry: Package review tools

• Host: GitHub
• URL: https://github.com/ropensci-archive/pkginspector
• Owner: ropensci-archive
• License: other
• Archived: true
• Created: 2018-05-30T03:36:22.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-05-10T14:10:57.000Z (over 2 years ago)
• Last Synced: 2024-06-12T14:29:51.071Z (5 months ago)
• Topics: r, r-package, rstats, unconf, unconf18
• Language: R
• Homepage:
• Size: 1.51 MB
• Stars: 16
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README-NOT.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - ropensci-archive/pkginspector - :no_entry: ARCHIVED :no_entry: Package review tools (R)

README

        


[![Project Status: Abandoned – Initial development has started, but there has not yet been a stable, usable release; the project has been abandoned and the author(s) do not intend on continuing development.](https://www.repostatus.org/badges/latest/abandoned.svg)](https://www.repostatus.org/#abandoned)

[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

[![Travis build

status](https://travis-ci.org/ropenscilabs/pkginspector.svg?branch=master)](https://travis-ci.org/ropenscilabs/pkginspector)

[![codecov](https://codecov.io/gh/ropenscilabs/pkginspector/branch/master/graph/badge.svg)](https://codecov.io/gh/ropenscilabs/pkginspector)

The goal of pkginspector is to inspect and better understand the

internal structure of an R package, with focus on facilitating package

reviews and [**rOpenSci**

onboarding](https://github.com/ropensci/onboarding).

## Installation

You can install pkginspector from GitHub with:

``` r

# install.packages("devtools")

devtools::install_github("ropenscilabs/pkginspector")

```

## Example

The inspected package must be stored locally and installed.

``` r

library(pkginspector)

path <- pkginspector_example("viridisLite")

knitr::kable(rev_fn_summary(path))

#> Warning in ls.str(pos = pos, envir = envir, mode = "function", ...):

#> partial argument match of 'all' to 'all.names'

```

| f\_name    | f\_args                                                                 | calls | called\_by | dependents |

| :--------- | :---------------------------------------------------------------------- | ----: | ---------: | ---------: |

| cividis    | cividis (n, alpha = 1, begin = 0, end = 1, direction = 1)               |     1 |          0 |          0 |

| inferno    | inferno (n, alpha = 1, begin = 0, end = 1, direction = 1)               |     1 |          0 |          0 |

| magma      | magma (n, alpha = 1, begin = 0, end = 1, direction = 1)                 |     1 |          0 |          0 |

| plasma     | plasma (n, alpha = 1, begin = 0, end = 1, direction = 1)                |     1 |          0 |          0 |

| viridis    | viridis (n, alpha = 1, begin = 0, end = 1, direction = 1, option = “D”) |     0 |          4 |          4 |

| viridisMap | viridisMap (n = 256, alpha = 1, begin = 0, end = 1, direction = 1,      |     0 |          0 |          0 |

``` r

rev_args(path)

#> $arg_df

#>    arg_name n_functions default_consistent default_consistent_percent

#> 1         n           6              FALSE                   83.33333

#> 2     alpha           6               TRUE                  100.00000

#> 3     begin           6               TRUE                  100.00000

#> 4       end           6               TRUE                  100.00000

#> 5 direction           6               TRUE                  100.00000

#> 6    option           2               TRUE                  100.00000

#> 

#> $arg_map

#>               n alpha begin  end direction option

#> cividis    TRUE  TRUE  TRUE TRUE      TRUE  FALSE

#> inferno    TRUE  TRUE  TRUE TRUE      TRUE  FALSE

#> magma      TRUE  TRUE  TRUE TRUE      TRUE  FALSE

#> plasma     TRUE  TRUE  TRUE TRUE      TRUE  FALSE

#> viridis    TRUE  TRUE  TRUE TRUE      TRUE   TRUE

#> viridisMap TRUE  TRUE  TRUE TRUE      TRUE   TRUE

corrplot::corrplot(rev_args(path)$arg_map, method = 'square', cl.pos = "n")

```

![](tools/readme/README-rev_args-1.png)

## Information

  - [Getting help](SUPPORT.md).

  - [Contributing](CONTRIBUTING.md).

  - [Contributor Code of Conduct](CODE_OF_CONDUCT.md).