proftools (version 0.99-3)

summaries: Basic Profile Data Summaries

Description

Functions to summarize profile data.

Usage

funSummary(pd, byTotal = TRUE, value = c("pct", "time", "hits"),
           srclines = TRUE, GC = TRUE, memory = FALSE, self.pct = 0, total.pct = 0)
callSummary(pd, byTotal = TRUE, value = c("pct", "time", "hits"),
            srclines = TRUE, GC = TRUE, memory = FALSE, self.pct = 0, total.pct = 0)
pathSummary(pd, value = c("pct", "time", "hits"),
            srclines = FALSE, GC = TRUE, memory = FALSE, total.pct = 0, ...)
srcSummary(pd, byTotal = TRUE, value = c("pct", "time", "hits"),
           GC = TRUE, memory = FALSE, total.pct = 0, source = TRUE,
           width = getOption("width"))

Arguments

pd

profile data as returned by readProfileData.

byTotal

logical; sort by total or by self time.

value

character; show result as percentage, time, or hits.

srclines

logical; include source information, if available, or not.

GC

logical; include GC information or not.

memory

logical; include memory use information or not.

self.pct

numeric; functions at the bottom of the stacks with self percentages below this value are removed.

total.pct

numeric; functions at the top of the stacks with total percentages below this value are removed.

source

logical; if true, include source lines if available.

width

maximal line length to use; source lines are abbreviated to fit if necessary.

...

arguments to control path formatting; not useful at this time.

Value

A data frame of summary information.

Details

funSummary returns a summary of the time spent in each function, or each call site if source information is available and requested. It is similar to flatProfile.

callSummary provides a breakdown by calls, again with an option of distinguishing call and callee sites if source information is available.

pathSummary returns a summary of time spent in each unique call path contained in the profile data.

For profile data containing source information srcSummary returns a summary of time spent in each file line recorded in the profile data.

See Also

Rprof, flatProfile, summaryRprof, readProfileData, plotProfileCallGraph, printProfileCallGraph, profileCallGraph2Dot

Examples

# NOT RUN {
pd <- readProfileData(system.file("samples", "glmEx.out", package="proftools"))
funSummary(pd)
callSummary(pd)
pathSummary(pd)
# }