as.tblEntries: Promote a Data Frame to a 'tblentries' Object

View source: R/as.dfObj.bare.R

as.tblEntriesR Documentation

Promote a Data Frame to a tblentries Object

Description

Promote a data frame to a tblEntries object. This is an internal function not intended to be called by package users.

Usage

as.tblEntries(x)

Arguments

x

An object inheriting from data.frame. Each row represents one table entry, with information about its content, location, and structural role in the table. See dfSpecs for the required columns and types, and tblEntries for a description of these columns. x must also have attributes rowhier and colhier with information about the row and column header hierarchies (see headerRuns).

Details

Normally table entries are created from a textTable object via function tblEntries. This function allows them to be created or edited directly in a data frame.

Columns arow1, arow2, acol1 and acol2 refer to row and column numbers in the augmented row-column grid of the table; see adim for more information.

If x is already a tblEntries object, this function does some validity checks. If x is NULL, a valid but empty tblEntries object is returned.

Value

An object of S3 class tblEntries and data.frame.

See Also

tblEntries, headerRuns


tablesgg documentation built on June 22, 2024, 11:02 a.m.