num_rep_cols: Number of repeated columns

In formatters: ASCII Formatting for Values and Tables

Number of repeated columns

Description

When called on a table-like object using the formatters framework, this method returns the number of columns which are mandatorily repeated after each horizontal pagination.

Usage

num_rep_cols(obj)

## S4 method for signature 'ANY'
num_rep_cols(obj)

## S4 method for signature 'MatrixPrintForm'
num_rep_cols(obj)

num_rep_cols(obj) <- value

## S4 replacement method for signature 'ANY'
num_rep_cols(obj) <- value

## S4 replacement method for signature 'MatrixPrintForm'
num_rep_cols(obj) <- value

Arguments

obj	(ANY) a table-like object.
value	(numeric(1)) the new number of columns to repeat.

Details

Absent a class-specific method, this function returns 0, indicating no always-repeated columns.

Value

An integer.

Note

This number does not include row labels, the repetition of which is handled separately.

Examples

mpf <- basic_matrix_form(mtcars)
num_rep_cols(mpf)
lmpf <- basic_listing_mf(mtcars)
num_rep_cols(lmpf)

formatters documentation built on June 22, 2024, 9:42 a.m.