File: pander.survfit.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 (24 lines) | stat: -rw-r--r-- 853 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
24
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/S3.R
\name{pander.survfit}
\alias{pander.survfit}
\title{Pander method for survfit class}
\usage{
\method{pander}{survfit}(x, caption = attr(x, "caption"), scale = 1,
  print.rmean = getOption("survfit.print.rmean"),
  rmean = getOption("survfit.rmean"), ...)
}
\arguments{
\item{x}{the result of a call to the survfit function.}

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

\item{scale}{a numeric value to rescale the survival time, e.g., if the input data to survfit were in days, scale=365 would scale the printout to years.}

\item{print.rmean, rmean}{options for computation and display of the restricted mean}

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