formatters | Formatting values | Format labels | Table Rendering Framework
Package: formatters 0.5.12
Joe Zhu
formatters: ASCII Formatting for Values and Tables
We provide a framework for rendering complex tables to ASCII, and a set of formatters for transforming values or sets of values into ASCII-ready display strings.
Authors:
formatters_0.5.12.tar.gz
formatters_0.5.12.zip(r-4.7)formatters_0.5.12.zip(r-4.6)formatters_0.5.12.zip(r-4.5)
formatters_0.5.12.tgz(r-4.6-any)formatters_0.5.12.tgz(r-4.5-any)
formatters_0.5.12.tar.gz(r-4.7-any)formatters_0.5.12.tar.gz(r-4.6-any)
formatters_0.5.12.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
formatters/json (API)
| # Install 'formatters' in R: |
| install.packages('formatters', repos = c('https://insightsengineering.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/insightsengineering/formatters/issues
Pkgdown/docs site:https://insightsengineering.github.io
Datasets:
- DM - DM data
- 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
Last updated from:d581c8a1e0 (on v0.5.12). Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 161 | ||
| source / vignettes | OK | 170 | ||
| linux-release-x86_64 | OK | 164 | ||
| macos-release-arm64 | OK | 123 | ||
| macos-oldrel-arm64 | OK | 134 | ||
| windows-devel | OK | 106 | ||
| windows-release | OK | 113 | ||
| windows-oldrel | OK | 106 | ||
| wasm-release | OK | 177 |
Exports:%||%all_footersall_titlesbasic_listing_mfbasic_matrix_formbasic_pagdfcheck_alignsclose_font_devdebug_font_devdecimal_aligndefault_hsepdefault_page_numberdiagnose_paginationdivider_heightdo_forced_paginateexport_as_pdfexport_as_rtfexport_as_txtfmt_configfont_specformat_valueis_valid_formatis.wholenumberlist_valid_alignslist_valid_format_labelsmain_footermain_footer<-main_titlemain_title<-make_row_dfmatrix_formMatrixPrintFormmf_alignsmf_aligns<-mf_cinfomf_cinfo<-mf_colgapmf_colgap<-mf_displaymf_display<-mf_fontspecmf_fontspec<-mf_formatsmf_formats<-mf_has_rlabelsmf_has_topleftmf_lgroupingmf_lgrouping<-mf_ncolmf_ncol<-mf_nlheadermf_nrheadermf_nrheader<-mf_nrowmf_rfnotesmf_rfnotes<-mf_rinfomf_rinfo<-mf_spansmf_spans<-mf_stringsmf_strings<-mpf_has_rlabelsmpf_to_rtfnchar_ttypencolnlinesnum_rep_colsnum_rep_cols<-obj_alignobj_align<-obj_formatobj_format<-obj_labelobj_label<-obj_na_strobj_na_str<-obj_nameobj_name<-obj_round_typeobj_round_type<-open_font_devpadstrpag_indices_innerpagdfrowpage_dimpage_lcpppage_titlespage_titles<-page_typespaginate_indicespaginate_to_mpfspropose_column_widthsprov_footerprov_footer<-ref_df_rowround_fmtset_default_hsepset_default_page_numberspans_to_viscellsplit_word_ttypespread_integersprintf_formatsubtitlessubtitles<-table_insettable_inset<-toStringundebug_font_devvalid_round_typevar_labelsvar_labels_removevar_labels<-var_relabelvert_pag_indiceswith_labelwrap_stringwrap_string_ttypewrap_txt
Dependencies:backportsbase64enccheckmateclidigestfastmaphtmltoolslifecyclerlangstringi
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Basic/spoof pagination info data frame | basic_pagdf |
| Check if a format or alignment is supported | check_aligns check_formats is_valid_format |
| Decimal alignment | decimal_align |
| Default horizontal separator | default_horizontal_sep default_hsep set_default_hsep |
| Default page number format | default_page_number set_default_page_number |
| Divider height | divider_height divider_height,ANY-method |
| DM data | DM |
| Generic for performing "forced" pagination | do_forced_paginate do_forced_paginate,ANY-method |
| Simulated CDISC-like data for examples | ex_adae ex_adaette ex_adcm ex_adlb ex_admh ex_adqs ex_adrs ex_adsl ex_adtte ex_advs |
| Export as PDF | export_as_pdf |
| Export as RTF | export_as_rtf |
| Export a table-like object to plain (ASCII) text with page breaks | export_as_txt |
| Format configuration | fmt_config |
| Font size specification | font_spec |
| Converts a (possibly compound) value into a string using the 'format' information | format_value |
| %||% (if length-0) alternative operator | %||% ifnotlen0 |
| Check if a value is a whole number | is.wholenumber |
| Label, name, and format accessor generics | lab_name obj_align obj_align,ANY-method obj_align,fmt_config-method obj_align<- obj_align<-,ANY-method obj_align<-,fmt_config-method obj_format obj_format,ANY-method obj_format,fmt_config-method obj_format<- obj_format<-,ANY-method obj_format<-,fmt_config-method obj_label obj_label,ANY-method obj_label<- obj_label<-,ANY-method obj_name obj_name<- obj_na_str obj_na_str,ANY-method obj_na_str,fmt_config-method obj_na_str<- obj_na_str<-,ANY-method obj_na_str<-,fmt_config-method |
| List of currently supported formats and vertical alignments | list_formats list_valid_aligns list_valid_format_labels |
| General title and footer accessors | all_footers all_titles main_footer main_footer,MatrixPrintForm-method main_footer<- main_footer<-,MatrixPrintForm-method main_title main_title,MatrixPrintForm-method main_title<- main_title<-,MatrixPrintForm-method page_titles page_titles,ANY-method page_titles,MatrixPrintForm-method page_titles<- page_titles<-,MatrixPrintForm-method prov_footer prov_footer,MatrixPrintForm-method prov_footer<- prov_footer<-,MatrixPrintForm-method subtitles subtitles,MatrixPrintForm-method subtitles<- subtitles<-,MatrixPrintForm-method |
| Make row layout summary data frames for use during pagination | make_row_df make_row_df,MatrixPrintForm-method |
| Transform 'rtable' to a list of matrices which can be used for outputting | matrix_form matrix_form,MatrixPrintForm-method |
| Constructor for Matrix Print Form | MatrixPrintForm |
| Class for Matrix Print Form | MatrixPrintForm-class |
| Getters and setters for aspects of 'MatrixPrintForm' objects | mf_aligns mf_aligns<- mf_cinfo mf_cinfo<- mf_colgap mf_colgap<- mf_display mf_display<- mf_fontspec mf_fontspec<- mf_formats mf_formats<- mf_has_rlabels mf_has_topleft mf_lgrouping mf_lgrouping<- mf_ncol mf_ncol<- mf_nlheader mf_nrheader mf_nrheader<- mf_nrow mf_rfnotes mf_rfnotes<- mf_rinfo mf_rinfo<- mf_spans mf_spans<- mf_strings mf_strings<- mpf_has_rlabels ncol,MatrixPrintForm-method |
| Transform 'MatrixPrintForm' to RTF | mpf_to_rtf |
| Calculate font-specific string width | nchar_ttype |
| Number of lines required to print a value | nlines nlines,character-method nlines,list-method nlines,NULL-method |
| Number of repeated columns | num_rep_cols num_rep_cols,ANY-method num_rep_cols,MatrixPrintForm-method num_rep_cols<- num_rep_cols<-,ANY-method num_rep_cols<-,MatrixPrintForm-method |
| Rounding Type | obj_round_type obj_round_type,list-method obj_round_type,MatrixPrintForm-method obj_round_type<- obj_round_type<-,list-method obj_round_type<-,MatrixPrintForm-method |
| Activate font state | close_font_dev debug_font_dev open_font_dev undebug_font_dev |
| Pad a string and align within string | padstr |
| Find pagination indices from pagination info data frame | pag_indices_inner |
| Create a row of a pagination data frame | pagdfrow |
| Determine lines per page (LPP) and characters per page (CPP) based on font and page type | page_lcpp |
| Supported named page types | page_dim page_types |
| Paginate a table-like object for rendering | diagnose_pagination paginate paginate_indices paginate_to_mpfs pagination |
| Pagination | pagination_algo |
| print,ANY-method | |
| Propose column widths based on the 'MatrixPrintForm' of an object | propose_column_widths |
| Create a row for a referential footnote information data frame | ref_df_row |
| Transform a vector of spans (with duplication) into a visibility vector | spans_to_viscell |
| wrap string given a Truetype font | split_word_ttype wrap_string_ttype |
| Spread an integer to a given length | spread_integer |
| Specify text format via a 'sprintf' format string | sprintf_format |
| Access or (recursively) set table inset | table_inset table_inset,MatrixPrintForm-method table_inset<- table_inset<-,MatrixPrintForm-method |
| Create spoof matrix form from a data frame | basic_listing_mf basic_matrix_form test_matrix_form |
| Transform objects into string representations | toString toString,MatrixPrintForm-method |
| Round and prepare a value for display | rounding round_fmt valid_round_type |
| Get label attributes of variables in a 'data.frame' | var_labels |
| Remove variable labels of a 'data.frame' | var_labels_remove |
| Set label attributes of all variables in a 'data.frame' | var_labels<- |
| Copy and change variable labels of a 'data.frame' | var_relabel |
| Find column indices for vertical pagination | vert_pag_indices |
| Return an object with a label attribute | with_label |
| Wrap a string to a precise width | wrap_string wrap_txt |
