Function reference • formatters

Formatting Values

Functions related to applying formats to values

format_value(): Converts a (possibly compound) value into a string using the format information

round_fmt(): Round and prepare a value for display

is_valid_format() check_aligns(): Check if a format or alignment is supported

is.wholenumber(): is.wholenumber

list_valid_format_labels() list_valid_aligns(): List with currently supported formats and vertical alignments

sprintf_format(): Specify text format via a sprintf format string

fmt_config(): Format Configuration

Generics Interface For Pagination

Generics requried for pagination machinery

make_row_df(): Make row layout summary data.frames for use during pagination

pagdfrow(): Create row of pagination data frame

nlines nlines,list-method nlines,NULL-method nlines,character-method: Number of lines required to print a value

divider_height(): Divider Height

main_title() `main_title<-`() subtitles() `subtitles<-`() page_titles() `page_titles<-`() main_footer() `main_footer<-`() prov_footer() `prov_footer<-`() all_footers() all_titles(): General title/footer accessors

num_rep_cols(): Number of repeated columns

do_forced_paginate(): Generic for Performing "Forced Pagination"

Generics Interface for ASCII Rendering

Generics required for rendering table-like object to ASCII

matrix_form(): Transform rtable to a list of matrices which can be used for outputting

basic_matrix_form(): Create spoof matrix form from a data.frame

MatrixPrintForm

MatrixPrintForm class and constructor

MatrixPrintForm() matrix_print_form(): Matrix Print Form - Intermediate Representation for ASCII Table Printing

MatrixPrintForm-class: Matrix Print Form - Intermediate Representation for ASCII Table Printing

ASCII Rendering of MatrixPrintForm objects

ASCII rendering-related functions which operate on MatrixPrintForm objects

toString(): toString

spans_to_viscell(): Transform vectors of spans (with duplication) to Visibility vector

propose_column_widths(): Propose Column Widths based on an object's MatrixPrintForm form

decimal_align(): Decimal Alignment

list_valid_format_labels() list_valid_aligns(): List with currently supported formats and vertical alignments

padstr(): Pad a string and align within string

spread_integer(): spread x into len elements

is.wholenumber(): is.wholenumber

Pagination

Pagination functionality

paginate_indices() paginate_to_mpfs() diagnose_pagination(): Paginate a table-like object for rendering

pagination_algo: Pagination

pag_indices_inner(): Find Pagination Indices From Pagination Info Dataframe

vert_pag_indices(): Find Column Indices for Vertical Pagination

pagdfrow(): Create row of pagination data frame

basic_pagdf(): Basic/spoof pagination info dataframe

Variable Labels

Functions for Assigning Labels to Variables In Data

`var_labels<-`(): Set Label Attributes of All Variables in a data.frame

var_labels(): Get Label Attributes of 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

with_label(): Return an object with a label attribute

General Accessors

General accessors

obj_name() `obj_name<-`() obj_label() `obj_label<-`() obj_format() `obj_format<-`() obj_na_str() `obj_na_str<-`() obj_align() `obj_align<-`(): Label, Name and Format accessor generics

Data

Data included with the package

ex_adsl ex_adae ex_adaette ex_adtte ex_adcm ex_adlb ex_admh ex_adqs ex_adrs ex_advs: Simulated CDISC Alike Data for Examples

DM: DM data

Export

Export into different object

export_as_txt(): Export a table-like object to plain (ASCII) text with page break

export_as_rtf(): Export table to RTF

mpf_to_rtf(): Transform MPF to RTF

Miscellany

Other documented functions not interesting to end users

print(<ANY>): Print

wrap_string() wrap_txt(): Wrap a string to within a maximum width

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

table_inset() `table_inset<-`(): Access or (recursively) set table inset.

default_hsep(): Default horizontal Separator

font_lcpi(): Calculate lines per inch and characters per inch for font

mf_strings() mf_spans() mf_aligns() mf_display() mf_formats() mf_rinfo() mf_cinfo() mf_has_topleft() mf_lgrouping() mf_rfnotes() mf_nlheader() mf_nrheader() mf_colgap() `mf_strings<-`() `mf_spans<-`() `mf_aligns<-`() `mf_display<-`() `mf_formats<-`() `mf_rinfo<-`() `mf_cinfo<-`() `mf_lgrouping<-`() `mf_rfnotes<-`() `mf_nrheader<-`() `mf_colgap<-`() mf_ncol() mf_nrow() `mf_ncol<-`() ncol(<MatrixPrintForm>) mpf_has_rlabels() mf_has_rlabels(): Setters and getters for aspects of MatrixPrintForm Objects

page_lcpp(): Determine lines per page (LPP) and characters per page (CPP) based on font and page type

page_types() page_dim(): Supported Named Page TypesList supported named page types

ref_df_row(): Create a row for a referential footnote information dataframe