get_pnet: use pkgnet to analyze a source folder (including covr...

Description Usage Arguments Value Note Examples

View source: R/new.R

Description

use pkgnet to analyze a source folder (including covr statistics)

Usage

1
get_pnet(sourcedir, serialize = TRUE, overwrite = TRUE)

Arguments

sourcedir

character(1) should contain an R package

serialize

logical(1) defaults to TRUE, See note.

overwrite

logical(1) defaults to TRUE; if FALSE will fail if [basename(sourcedir)]_pnet.rds exists

Value

See Note.

Note

By default, serializes an S3 instance of BBT_pkgnet, a list with components dep for dependency report, and fun for function interrelationships, saved as RDS to [basename(sourcedir)]_pnet.rds. If serialize is FALSE, simply returns the object. This is intended to be used on a large number of packages and thus a checkpointing approach is the default.

Examples

1
2
3
4
5
6
7
8
td = tempdir()
cur = getwd()
setwd(td)
pdy = system.file("demo_srcs/parody", package="BiocQE")
get_pnet(pdy)
file.exists("parody_pnet.rds")
class(readRDS("parody_pnet.rds"))
setwd(cur)

vjcitn/BiocQE documentation built on Dec. 30, 2021, 12:20 a.m.