File: pander.microbenchmark.Rd

package info (click to toggle)
r-cran-pander 0.6.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,804 kB
  • sloc: javascript: 301; cpp: 145; lisp: 94; makefile: 21
file content (23 lines) | stat: -rw-r--r-- 839 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/S3.R
\name{pander.microbenchmark}
\alias{pander.microbenchmark}
\title{Pander method for microbenchmark class}
\usage{
\method{pander}{microbenchmark}(x, caption = attr(x, "caption"),
  expr.labels, unit, ...)
}
\arguments{
\item{x}{an microbenchmark object}

\item{caption}{caption (string) to be shown under the table}

\item{expr.labels}{expression labels that will replace default ones (similar to rownames, which microbenchmark class table does not have)}

\item{unit}{units in which values should be printed (for example second, microseconds, etc.). Should be one of ns, us, ms, s, t, hz, khz, mhz, eps, f}

\item{...}{optional parameters passed to raw \code{pandoc.table} function}
}
\description{
Prints an microbenchmark object in Pandoc's markdown.
}