File: mtable-format-print.Rd

package info (click to toggle)
r-cran-memisc 0.99.31.8.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,136 kB
  • sloc: ansic: 5,117; makefile: 2
file content (39 lines) | stat: -rw-r--r-- 1,376 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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
\name{mtable_format_print}
\alias{mtable_format_print}
\title{Print Format for 'mtable' Objects}
\description{
  \code{mtable_format_print} formats 'mtable' in a way suitable for screen output
  with 'print'.
  }
\usage{
mtable_format_print(x,
  topsep="=",
  bottomsep="=",
  sectionsep="-",
  interaction.sep = " x ",
  center.at=getOption("OutDec"),
  align.integers=c("dot","right","left"),
  padding = "  ",
  \dots
  )
}
\arguments{
     \item{x}{an object of class \code{mtable}}
     \item{topsep}{a character string that is recycled to a top rule.}
     \item{bottomsep}{a character string that is recycled to a bottom rule.}
     \item{sectionsep}{a character string that is recycled to seperate coefficients
        from summary statistics.}
     \item{interaction.sep}{a character string that separates factors that are involved
        in an interaction effect}
     \item{center.at}{a character string on which resulting values are centered.
        Typically equal to ".". This is the default when \code{forLaTeX==TRUE}.
        If \code{NULL}, reported values are not centered.}
    \item{align.integers}{how to align integer values.}
    \item{padding}{a character string, usually whitespace, used to insert left- and right-padding of 
        table contents.}
    \item{\dots}{further arguments, ignored. }
}
\value{
    A character string.
}
\keyword{misc}