Condense the output ofpkgstats to summary statistics only

Condense the output ofpkgstats to summary statistics only

Usage

pkgstats_summary(s=NULL)

Arguments

s

Output ofpkgstats, containing full statistical data on onepackage. Default ofNULL returns a single row withNA values (used inpkgstats_from_archive).

Value

Summarised version ofs, as a single row of a standardiseddata.frame object

Note

Variable names in the summary object use the following abbreviations:

• "loc" = Lines-of-Code

• "fn" = Function

• "n_fns" = Number of functions

• "npars" = Number of parameters

• "doclines" = Number of documentation lines

• "nedges" = Number of edges in function call network, as a count ofunique edges, which may be less than the size of thenetworkobject returned bypkgstats, because that may include multiple callsbetween identical function pairs.

• "n_clusters" = Number of connected clusters within the function callnetwork.

• "centrality" used as a prefix for several statistics, along with"dir" or "undir" for centrality calculated on networks respectivelyconstructed with directed or undirected edges; "mn" or "md" for respectivemeasures of mean or median centrality, and "no0" for measures excludingedges with zero centrality.

See also

Examples

f<-system.file("extdata","pkgstats_9.9.tar.gz", package="pkgstats")if(FALSE){# ctags_test(noerror = TRUE)p<-pkgstats(f)s<-pkgstats_summary(p)}