Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Doc tweaks

  • Loading branch information...
commit b92eebed6091ea02228f97da56f0e56b1ce4d0e7 1 parent de73b6d
@hadley authored
Showing with 12 additions and 11 deletions.
  1. +5 −5 R/parse.r
  2. +7 −6 man/parse_rprof.Rd
View
10 R/parse.r
@@ -1,9 +1,8 @@
#' Parse Rprof output.
+#'
#' Parses the output of \code{\link{Rprof}} into an alternative format
-#' described in \code{\link{profr}}.
-#'
-#' This produces a flat data frame, which is somewhat easier to summarise
-#' and visualise.
+#' described in \code{\link{profr}}. This produces a flat data frame, which is
+#' somewhat easier to summarise and visualise.
#'
#' @param path path to \code{\link{Rprof}} output
#' @param interval real-time interval between samples (in seconds)
@@ -13,7 +12,8 @@
#' @import stringr plyr
#' @export
#' @examples
-#' nesting <- parse_rprof(system.file("samples", "nesting.rprof", package="profr"))
+#' nesting_ex <- system.file("samples", "nesting.rprof", package="profr")
+#' nesting <- parse_rprof(nesting_ex)
#'
#' reshape_ex <- system.file("samples", "reshape.rprof", package="profr")
#' diamonds <- parse_rprof(reshape_ex)
View
13 man/parse_rprof.Rd
@@ -4,14 +4,14 @@
\usage{parse_rprof(path, interval=0.02)}
\description{
- Parse Rprof output. Parses the output of
- \code{\link{Rprof}} into an alternative format described
- in \code{\link{profr}}.
+ Parse Rprof output.
}
\details{
- This produces a flat data frame, which is somewhat easier
- to summarise and visualise.
+ Parses the output of \code{\link{Rprof}} into an
+ alternative format described in \code{\link{profr}}. This
+ produces a flat data frame, which is somewhat easier to
+ summarise and visualise.
}
\keyword{debugging}
\value{\code{\link{data.frame}} of class \code{profr}}
@@ -20,7 +20,8 @@
\item{path}{path to \code{\link{Rprof}} output}
\item{interval}{real-time interval between samples (in seconds)}
}
-\examples{nesting <- parse_rprof(system.file("samples", "nesting.rprof", package="profr"))
+\examples{nesting_ex <- system.file("samples", "nesting.rprof", package="profr")
+nesting <- parse_rprof(nesting_ex)
reshape_ex <- system.file("samples", "reshape.rprof", package="profr")
diamonds <- parse_rprof(reshape_ex)
Please sign in to comment.
Something went wrong with that request. Please try again.