ASCII Formatting for Values and Tables

---

Documentation for package ‘formatters’ version 0.5.5

• DESCRIPTION file.
• User guides, package vignettes and other documentation.
• Package NEWS.

Help Pages

A B C D E F I L M N O P R S T V W misc

formatters-package

formatters Package

-- A --

all_footers	General title/footer accessors
all_titles	General title/footer accessors

-- B --

basic_matrix_form	Create spoof matrix form from a data.frame
basic_pagdf	Basic/spoof pagination info dataframe

-- C --

check_aligns	Check if a format or alignment is supported
check_formats	Check if a format or alignment is supported

-- D --

decimal_align	Decimal Alignment
default_horizontal_sep	Default horizontal separator
default_hsep	Default horizontal separator
diagnose_pagination	Paginate a table-like object for rendering
divider_height	Divider Height
divider_height-method	Divider Height
DM	'DM' data
do_forced_paginate	Generic for Performing "Forced Pagination"
do_forced_paginate-method	Generic for Performing "Forced Pagination"

-- E --

export_as_pdf	Export as PDF
export_as_rtf	Export table to 'RTF'
export_as_txt	Export a table-like object to plain (ASCII) text with page break
ex_adae	Simulated 'CDISC' Alike Data for Examples
ex_adaette	Simulated 'CDISC' Alike Data for Examples
ex_adcm	Simulated 'CDISC' Alike Data for Examples
ex_adlb	Simulated 'CDISC' Alike Data for Examples
ex_admh	Simulated 'CDISC' Alike Data for Examples
ex_adqs	Simulated 'CDISC' Alike Data for Examples
ex_adrs	Simulated 'CDISC' Alike Data for Examples
ex_adsl	Simulated 'CDISC' Alike Data for Examples
ex_adtte	Simulated 'CDISC' Alike Data for Examples
ex_advs	Simulated 'CDISC' Alike Data for Examples

-- F --

fmt_config	Format Configuration
formatters	formatters Package
format_value	Converts a (possibly compound) value into a string using the 'format' information

-- I --

ifnotlen0	%||% If length-0 alternative operator
is.wholenumber	'is.wholenumber'
is_valid_format	Check if a format or alignment is supported

-- L --

lab_name	Label, Name and Format accessor generics
list_formats	List with currently supported formats and vertical alignments
list_valid_aligns	List with currently supported formats and vertical alignments
list_valid_format_labels	List with currently supported formats and vertical alignments

-- M --

main_footer	General title/footer accessors
main_footer-method	General title/footer accessors
main_footer<-	General title/footer accessors
main_footer<--method	General title/footer accessors
main_title	General title/footer accessors
main_title-method	General title/footer accessors
main_title<-	General title/footer accessors
main_title<--method	General title/footer accessors
make_row_df	Make row layout summary data.frames for use during pagination
make_row_df-method	Make row layout summary data.frames for use during pagination
MatrixPrintForm	Matrix Print Form - Intermediate Representation for ASCII Table Printing
MatrixPrintForm-class	Matrix Print Form - Intermediate Representation for ASCII Table Printing
matrix_form	Transform 'rtable' to a list of matrices which can be used for outputting
matrix_form-method	Transform 'rtable' to a list of matrices which can be used for outputting
matrix_print_form	Matrix Print Form - Intermediate Representation for ASCII Table Printing
mf_aligns	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_aligns<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_cinfo	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_cinfo<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_colgap	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_colgap<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_display	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_display<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_formats	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_formats<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_has_rlabels	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_has_topleft	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_lgrouping	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_lgrouping<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_ncol	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_ncol<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_nlheader	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_nrheader	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_nrheader<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_nrow	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_rfnotes	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_rfnotes<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_rinfo	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_rinfo<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_spans	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_spans<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_strings	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mf_strings<-	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mpf_has_rlabels	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
mpf_to_rtf	Transform 'MPF' to 'RTF'

-- N --

ncol-method	'Setters' and 'getters' for aspects of 'MatrixPrintForm' Objects
nlines	Number of lines required to print a value
nlines-method	Number of lines required to print a value
num_rep_cols	Number of repeated columns
num_rep_cols-method	Number of repeated columns

-- O --

obj_align	Label, Name and Format accessor generics
obj_align-method	Label, Name and Format accessor generics
obj_align<-	Label, Name and Format accessor generics
obj_align<--method	Label, Name and Format accessor generics
obj_format	Label, Name and Format accessor generics
obj_format-method	Label, Name and Format accessor generics
obj_format<-	Label, Name and Format accessor generics
obj_format<--method	Label, Name and Format accessor generics
obj_label	Label, Name and Format accessor generics
obj_label-method	Label, Name and Format accessor generics
obj_label<-	Label, Name and Format accessor generics
obj_label<--method	Label, Name and Format accessor generics
obj_name	Label, Name and Format accessor generics
obj_name<-	Label, Name and Format accessor generics
obj_na_str	Label, Name and Format accessor generics
obj_na_str-method	Label, Name and Format accessor generics
obj_na_str<-	Label, Name and Format accessor generics
obj_na_str<--method	Label, Name and Format accessor generics

-- P --

padstr	Pad a string and align within string
pagdfrow	Create row of pagination data frame
page_dim	Supported Named Page 'TypesList' supported named page types
page_lcpp	Determine lines per page ('LPP') and characters per page ('CPP') based on font and page type
page_titles	General title/footer accessors
page_titles-method	General title/footer accessors
page_titles<-	General title/footer accessors
page_titles<--method	General title/footer accessors
page_types	Supported Named Page 'TypesList' supported named page types
paginate	Paginate a table-like object for rendering
paginate_indices	Paginate a table-like object for rendering
paginate_to_mpfs	Paginate a table-like object for rendering
pagination	Paginate a table-like object for rendering
pagination_algo	Pagination
pag_indices_inner	Find Pagination Indices From Pagination Info Dataframe
print-method	Print
propose_column_widths	Propose Column Widths based on an object's 'MatrixPrintForm' form
prov_footer	General title/footer accessors
prov_footer-method	General title/footer accessors
prov_footer<-	General title/footer accessors
prov_footer<--method	General title/footer accessors

-- R --

ref_df_row	Create a row for a referential footnote information dataframe
rounding	Round and prepare a value for display
round_fmt	Round and prepare a value for display

-- S --

set_default_hsep	Default horizontal separator
spans_to_viscell	Transform vectors of spans (with duplication) to Visibility vector
spread_integer	spread 'x' into 'len' elements
sprintf_format	Specify text format via a 'sprintf' format string
subtitles	General title/footer accessors
subtitles-method	General title/footer accessors
subtitles<-	General title/footer accessors
subtitles<--method	General title/footer accessors

-- T --

table_inset	Access or (recursively) set table inset.
table_inset-method	Access or (recursively) set table inset.
table_inset<-	Access or (recursively) set table inset.
table_inset<--method	Access or (recursively) set table inset.
toString	'toString'
toString-method	'toString'

-- V --

var_labels	Get Label Attributes of Variables in a 'data.frame'
var_labels<-	Set Label Attributes of All Variables in a 'data.frame'
var_labels_remove	Remove Variable Labels of a 'data.frame'
var_relabel	Copy and Change Variable Labels of a 'data.frame'
vert_pag_indices	Find Column Indices for Vertical Pagination

-- W --

with_label	Return an object with a label attribute
wrap_string	Wrap a string to within a precise width
wrap_txt	Wrap a string to within a precise width

-- misc --

%||%	%||% If length-0 alternative operator