flat: Flatten a table, array or matrix

In mipfp: Multidimensional Iterative Proportional Fitting and Alternative Models

Description

This function takes a multidimensional object and flattens it for a pretty printing. The row names are the concatenation of the original dimension names while the only column stores the initial data of the object.

Usage

## S3 method for class 'array'
flat(x, sep = ".", label = "value", l.names = 0, ...)

## S3 method for class 'table'
flat(x, sep = ".", label = "value", l.names = 0, ...)

## S3 method for class 'matrix'
flat(x, sep = ".", label = "value", l.names = 0, ...)

Arguments

x	An array, table or matrix.
sep	The separator used to concatenate the dimension names.
label	The name of the column storing the data.
l.names	If set to a value greater than 0, then the dimnames will be shorten to a length of l.names characters.
...	Not used.

Value

An array containing a flattened version of x.

Note

The function is inspired from the function wrap.array from the package R.utils written by Henrik Bengtsson.

Author(s)

Johan Barthelemy.

Maintainer: Johan Barthelemy [e-mail].

See Also

The function wrap.array from the R.utils package (https://cran.r-project.org/package=R.utils).

Examples

# loading the data and saving in a 3D-table
data(spnamur, package = "mipfp")
spnamur.sub <- subset(spnamur, select = Household.type:Prof.status)
tab <- table(spnamur.sub)

# flattening the table
tab.flat <- flat(tab)
print(tab.flat)

Example output

Loading required package: cmm
Loading required package: Rsolnp
Loading required package: numDeriv
                                 
Household.type.Gender.Prof.status value
                            C.F.A  3621
                            F.F.A  6610
                            I.F.A  3011
                            N.F.A  2432
                            C.H.A  5216
                            F.H.A 11242
                            I.H.A  3384
                            N.H.A  1704
                            C.F.E   960
                            F.F.E  7946
                            I.F.E   634
                            N.F.E  2508
                            C.H.E   830
                            F.H.E  8144
                            I.H.E  1095
                            N.H.E  1998
                            C.F.I  7264
                            F.F.I 11590
                            I.F.I  5086
                            N.F.I  3335
                            C.H.I  5771
                            F.H.I  6904
                            I.H.I  2373
                            N.H.I  1590

mipfp documentation built on May 2, 2019, 6:01 a.m.