ASCII Formatting for Values and Tables

---

Documentation for package ‘formatters’ version 0.5.6

• 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 and footer accessors
all_titles	General title and footer accessors

-- B --

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

-- 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
default_page_number	Default page number format
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 as RTF
export_as_txt	Export a table-like object to plain (ASCII) text with page breaks
ex_adae	Simulated CDISC-like data for examples
ex_adaette	Simulated CDISC-like data for examples
ex_adcm	Simulated CDISC-like data for examples
ex_adlb	Simulated CDISC-like data for examples
ex_admh	Simulated CDISC-like data for examples
ex_adqs	Simulated CDISC-like data for examples
ex_adrs	Simulated CDISC-like data for examples
ex_adsl	Simulated CDISC-like data for examples
ex_adtte	Simulated CDISC-like data for examples
ex_advs	Simulated CDISC-like 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	Check if a value is a whole number
is_valid_format	Check if a format or alignment is supported

-- L --

lab_name	Label, name, and format accessor generics
list_formats	List of currently supported formats and vertical alignments
list_valid_aligns	List of currently supported formats and vertical alignments
list_valid_format_labels	List of currently supported formats and vertical alignments

-- M --

main_footer	General title and footer accessors
main_footer-method	General title and footer accessors
main_footer<-	General title and footer accessors
main_footer<--method	General title and footer accessors
main_title	General title and footer accessors
main_title-method	General title and footer accessors
main_title<-	General title and footer accessors
main_title<--method	General title and 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	Constructor for Matrix Print Form
MatrixPrintForm-class	Class for Matrix Print Form
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
mf_aligns	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_aligns<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_cinfo	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_cinfo<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_colgap	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_colgap<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_display	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_display<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_formats	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_formats<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_has_rlabels	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_has_topleft	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_lgrouping	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_lgrouping<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_ncol	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_ncol<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_nlheader	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_nrheader	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_nrheader<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_nrow	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_rfnotes	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_rfnotes<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_rinfo	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_rinfo<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_spans	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_spans<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_strings	Getters and setters for aspects of 'MatrixPrintForm' objects
mf_strings<-	Getters and setters for aspects of 'MatrixPrintForm' objects
mpf_has_rlabels	Getters and setters for aspects of 'MatrixPrintForm' objects
mpf_to_rtf	Transform 'MatrixPrintForm' to RTF

-- N --

ncol-method	Getters and setters 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 a row of a pagination data frame
page_dim	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 and footer accessors
page_titles-method	General title and footer accessors
page_titles<-	General title and footer accessors
page_titles<--method	General title and footer accessors
page_types	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 data frame
print-method	Print
propose_column_widths	Propose column widths based on the 'MatrixPrintForm' of an object
prov_footer	General title and footer accessors
prov_footer-method	General title and footer accessors
prov_footer<-	General title and footer accessors
prov_footer<--method	General title and footer accessors

-- R --

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

-- S --

set_default_hsep	Default horizontal separator
set_default_page_number	Default page number format
spans_to_viscell	Transform a vector of spans (with duplication) into a visibility vector
spread_integer	Spread an integer to a given length
sprintf_format	Specify text format via a 'sprintf' format string
subtitles	General title and footer accessors
subtitles-method	General title and footer accessors
subtitles<-	General title and footer accessors
subtitles<--method	General title and 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
test_matrix_form	Create spoof matrix form from a data frame
toString	Transform objects into string representations
toString-method	Transform objects into string representations

-- 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 a precise width
wrap_txt	Wrap a string to a precise width

-- misc --

%||%	%||% (if length-0) alternative operator