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.
You can install pkginspector from GitHub with:
# install.packages("devtools")
devtools::install_github("ropenscilabs/pkginspector")
The inspected package must be stored locally and installed.
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 |
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")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.