_pkgdown.yml

url: https://insightsengineering.github.io/formatters
template:
  package: nesttemplate
navbar:
  structure:
    left: [intro, reference, articles, tutorials, news, reports]
    right: [search, github]
  components:
    reports:
      text: Reports
      menu:
      - text: Coverage report
        href: coverage-report/
      - text: Unit test report
        href: unit-test-report/
      - text: Non-CRAN unit test report
        href: unit-test-report-non-cran/
    github:
      icon: fa-github
      href: https://github.com/insightsengineering/formatters
reference:
  - title: Formatters Overview
    contents:
      - formatters-package
  - title: Formatting Values
    desc: Functions related to applying formats to values
    contents:
      - format_value
      - round_fmt
      - is_valid_format
      - is.wholenumber
      - list_valid_format_labels
      - sprintf_format
      - fmt_config
  - title: Generics Interface For Pagination
    desc: Generics required for pagination machinery
    contents:
      - make_row_df
      - pagdfrow
      - nlines
      - divider_height
      - main_title
      - num_rep_cols
      - do_forced_paginate
  - title: Generics Interface for ASCII Rendering
    desc: Generics required for rendering table-like object to ASCII
    contents:
      - matrix_form
      - basic_matrix_form
  - title: MatrixPrintForm
    desc: Intermediate representation for ASCII table printing
    contents:
      - MatrixPrintForm
      - MatrixPrintForm-class
  - title: ASCII Rendering of MatrixPrintForm objects
    desc: ASCII rendering-related functions which operate on MatrixPrintForm objects
    contents:
      - toString,MatrixPrintForm-method
      - spans_to_viscell
      - propose_column_widths
      - decimal_align
      - list_valid_aligns
      - padstr
      - spread_integer
      - is.wholenumber
  - title: Pagination
    contents:
      - paginate_indices
      - pagination_algo
      - pag_indices_inner
      - vert_pag_indices
      - pagdfrow
      - basic_pagdf
  - title: Variable Labels
    desc: Functions for assigning labels to variables in data
    contents:
      - var_labels<-
      - var_labels
      - var_labels_remove
      - var_relabel
      - with_label
  - title: General Accessors
    contents:
      - starts_with("obj_")
  - title: Data
    desc: Data included with the package
    contents:
      - ex_adsl
      - DM
  - title: Export
    desc: Export into different object types
    contents:
      - export_as_txt
      - export_as_rtf
      - export_as_pdf
      - mpf_to_rtf
  - title: Miscellany
    desc: Other documented functions used by developers of this package
    contents:
      - print,ANY-method
      - wrap_string
      - wrap_string_ttype
      - wrap_txt
      - ifnotlen0
      - table_inset
      - default_horizontal_sep
      - mf_strings
      - page_lcpp
      - page_types
      - ref_df_row
      - default_page_number
      - set_default_page_number
  - title: Font support
    desc: Functions related to font support for pagination
    contents:
      - font_spec
      - nchar_ttype
      - open_font_dev