# ASCII Formatting for Values and Tables

## Documentation for package ‘formatters’ version 0.2.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

%||% | '%||%' If length-0 alternative operator
all_footers | General title/footer accessors
all_titles | General title/footer accessors
basic_matrix_form | Create spoof matrix form from a data.frame
basic_pagdf | Basic/spoof pagination info dataframe
divider_height | Divider Height
divider_height-method | Divider Height
DM | DM data
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
format_value | Converts a (possibly compound) value into a string using the 'format' information
ifnotlen0 | '%||%' If length-0 alternative operator
is.wholenumber | is.wholenumber
is_valid_format | Check if a format is supported
lab_name | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
list_valid_format_labels | List with currently support 'xx' style format labels grouped by 1d, 2d and 3d
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
make_row_df | Make row and column 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
nlines | Number of lines required to print a value
nlines-method | Number of lines required to print a value
obj_format | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
obj_format-method | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
obj_format<- | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
obj_format<--method | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
obj_label | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
obj_label-method | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
obj_label<- | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
obj_label<--method | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
obj_name | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
obj_name<- | Label, Name and Format accessor generics Getters and setters for basic, relatively universal attributes of "table-like" objects"
padstr | Pad a string and align within string
pagdfrow | Create row of pagination data frame
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
pag_indices_inner | Find Pagination Indices From Pagination Info Dataframe
print-method | Print Print an R object. see '[base::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
rounding | Round and prepare a value for display
round_fmt | Round and prepare a value for display
spans_to_viscell | Transform vectors of spans (with dupblication) 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
toString | toString Transform a complex object into a string representation ready to be printed or written to a plain-text file
toString-method | toString Transform a complex object into a string representation ready to be printed or written to a plain-text file
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 Indicies for Vertical Pagination
with_label | Return an object with a label attribute