HSAURtable: Produce LaTeX Tables

View source: R/tables.R

HSAURtableR Documentation

Produce LaTeX Tables

Description

Generate longtable LaTeX environments.

Usage

HSAURtable(object, ...)
## S3 method for class 'table'
HSAURtable(object, xname = deparse(substitute(object)), pkg = NULL, 
    ...)
## S3 method for class 'data.frame'
HSAURtable(object, xname = deparse(substitute(object)), pkg = NULL,
    nrows = NULL,  ...)
## S3 method for class 'tabtab'
toLatex(object, caption = NULL, label = NULL, 
    topcaption = TRUE, index = TRUE, ...)
## S3 method for class 'dftab'
toLatex(object, pcol = 1, caption = NULL, 
    label = NULL, rownames = FALSE, topcaption = TRUE, index = TRUE, 
    ...)

Arguments

object

an object of table or data.frame.

xname

the name of the object.

pkg

the package object comes from, optionally.

nrows

the number of rows actually printed for a data.frame.

caption

the (optional) caption of the table without label.

label

the (optional) label to be defined for this table.

pcol

the number of parallel columns.

rownames

logical, should the rownames be printed in the first row without column name?

topcaption

logical, should the captions be placed on top (default) of the table?

index

logical, should an index entry be generated?

...

additional arguments, currently ignored.

Details

Based on the data in object, an object from which a Latex table (in a longtable environment) may be constructed (via toLatex) is generated.

Value

An object of class tabtab or dftab for which toLatex methods are available.

toLatex produces objects of class Latex, a character vector, essentially.

Examples


  data("rearrests", package = "HSAUR3")
  toLatex(HSAURtable(rearrests), 
          caption = "Rearrests of juvenile felons.", 
          label = "rearrests_tab")


HSAUR3 documentation built on Sept. 11, 2024, 8:37 p.m.