Package 'TableToLongForm'

Convert a Table to a LongForm data.frame

Description

TableToLongForm automatically converts hierarchical Tables intended for a human reader into a simple LongForm Dataframe that is machine readable.

Details

Package:	TableToLongForm
Type:	Package
Version:	1.3.1
Date:	2014-08-01
License:	GPL-3

Call TableToLongForm() on a Table to automatically convert it to a LongForm data.frame.

Examples of Tables that can be converted are found in data(TCData).

For more details on what TableToLongForm does and what sorts of Tables it can convert, refer to the website: https://www.stat.auckland.ac.nz/~joh024/Research/TableToLongForm/

Available help: help(TableToLongForm) help(TCData)

Author(s)

Jimmy Oh

Maintainer: Jimmy Oh <[email protected]>

---

Print Method for plist Objects

Description

A print method for class plist, which are nested lists with a numeric vector at the lowest level, used as print.default is rather inefficient (and much uglier) when displaying such nested lists.

Arguments

x	a plist object.
...	potential further arguments (required by generic), unused by this method

Details

plist objects are created as part of diagnostic output for TableToLongForm. For more information, refer to the website: https://www.stat.auckland.ac.nz/~joh024/Research/TableToLongForm/

---

Convert a Table to a LongForm data.frame

Description

TableToLongForm automatically converts hierarchical Tables intended for a human reader into a simple LongForm Dataframe that is machine readable.

Use this function to run TableToLongForm on the specified matrix Table. All other arguments are optional.

Once the conversion is complete, the user is recommended to check the result for correctness and to consider tidying up the variable names.

Usage

TableToLongForm(Table, IdentResult = NULL,
                IdentPrimary = "combound",
                IdentAuxiliary = "sequence",
                ParePreRow = NULL,
                ParePreCol = c("mismatch", "misalign", "multirow"),
                fulloutput = FALSE,
                diagnostics = FALSE, diagnostics.trim = TRUE)

Arguments

Table	the Table to convert, given as a character matrix. Also accepts a data.frame, which is coerced to a matrix with a warning.
IdentResult	an optional list specifying the locations of the various elements of the Table. By default this is automatically generated but it can be specified manually where the automatic detection fails.
IdentPrimary	The Primary Ident algorithm, of which one is chosen. See details.
IdentAuxiliary	Auxiliary Ident algorithms, of which any combination, in any order, can be chosen. They are called after the Primary algorithm, to refine the IdentResult. See details.
ParePreRow	Pre-requisite algorithms that tidy up the Row Labels for correct operation of the Main Parentage algorithm. Any combination of these algorithms, in any order, can be chosen. See details.
ParePreCol	Pre-requisite algorithms that tidy up the Column Labels for correct operation of the Main Parentage algorithm. Any combination of these algorithms, in any order, can be chosen. See details.
fulloutput	if TRUE, returns a list containing additional information primarily useful for diagnostic purposes. Otherwise, and by default, the function only returns the converted data.frame object.
diagnostics	a character vector specifying the name of the file diagnostic output will be written to. Can also be TRUE, in which case the file name will be the name of the object specified in Table.
diagnostics.trim	a logical indicating whether the diagnostics output should be trimmed. A good idea to keep TRUE (default) as trimmed output is generally more useful.

Details

For more details on TableToLongForm refer to the website: https://www.stat.auckland.ac.nz/~joh024/Research/TableToLongForm/

Specifically, the 'Technical Report' gives a rounded introduction to TableToLongForm, including a short user manual, some examples and a complete gallery of recognised patterns.

'Working with Modules' gives an introduction to creating new modules/algorithms for TableToLongForm, to extend its capabilities.

Finally, the Literate Document has the complete documentation of the source code for TableToLongForm.

Value

The converted Table as a data.frame object.

Examples

## load Toy Examples data
  data(TCData)

  ## Convert ToyExComplete
  TableToLongForm(TCData$ToyExComplete)

---

Example hierarchical Tables

Description

A list containing a number of example Tables that can be converted to LongForm dataframes by TableToLongForm. Each Tables is stored as a character matrix.

These datasets are generally not immediately useful as data, as they must first be converted (e.g. by using TableToLongForm).

If the user prefers to have these data in their Global Environment rather than nested inside a single list, they can use attach(TCData).

Usage

data(TCData)

Format

list containing character matrices of varying size.

Source

Department of Internal Affairs (New Zealand) (2012) New Zealand Qualifications Authority (2012) Statistics New Zealand (2013)

Examples

data(TCData)

  ## list all Tables
  names(TCData)

  ## One such Toy Example Table
  TCData$ToyExByEmptyBelow

---

Register a new Module to TableToLongForm

Description

TableToLongForm is partially modular and can be extended in some ways with external modules. Registration of these modules with this function is necessary.

Arguments

Type	e.g. IdentPrimary
Fname	the name of the Function/Algorithm
Falias	the alias for the Function/Algorithm, which is used for the call to TableToLongForm
Author	(optional) name of the author of the algorithm
Description	(optional) a short description of the purpose of the algorithm

Details

For more details on modules, refer to the “Working with Modules” document on the website: https://www.stat.auckland.ac.nz/~joh024/Research/TableToLongForm/

---

List registered Modules for TableToLongForm

Description

TableToLongForm is partially modular and can be extended in some ways with external modules. This function is used to list currently registered modules.

Details

For more details on modules, refer to the “Working with Modules” document on the website: https://www.stat.auckland.ac.nz/~joh024/Research/TableToLongForm/

---