_pkgdown.yml

url: https://insightsengineering.github.io/rtables

template:
  package: nesttemplate

navbar:
  structure:
    left: [intro, reference, articles, dev-guide, news, reports]
    right: [search, github]
  components:
    github:
      icon: fa-github fa-lg
      href: https://github.com/insightsengineering/rtables
    dev-guide:
      text: Developer Guide
      menu:
        # Go to *REF1* below in this config and add any
        # additional topics that you may add here,
        # as you need to do so due to a pkgdown limitation.
        - text: Split Machinery
          href: articles/dev-guide/dg_split_machinery.html
        - text: Tabulation
          href: articles/dev-guide/dg_tabulation.html
        - text: Table Hierarchy
          href: articles/dev-guide/dg_table_hierarchy.html
        - text: Debugging in {rtables} and Beyond
          href: articles/dev-guide/dg_debug_rtables.html
        - text: Sparse Notes on {rtables} Internals
          href: articles/dev-guide/dg_notes.html
    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/

repo:
  url:
    home: https://github.com/insightsengineering/rtables/
    source: https://github.com/insightsengineering/rtables/blob/main/
    issue: https://github.com/insightsengineering/rtables/issues/
    user: https://github.com/
news:
  cran_dates: true

authors:
  before: "We define *authors* as those who are actively maintaining the code base, and *contributors* as those who made a significant contribution in the past. For all acknowledgements, see the eponymous section in the [Home Page](https://insightsengineering.github.io/rtables/)."
  footer:
    roles: [aut, ctb, cre, fnd]
    text: "Developed by"
  sidebar:
    roles: [aut]

articles:
  - title: Getting Started
    navbar: Getting Started
    contents:
    - rtables
    - exploratory_analysis

  - title: Clinical Trials
    navbar: Clinical Trials
    contents:
    - clinical_trials
    - baseline

  - title: Table Customization
    navbar: Table Customization
    contents:
    - custom_appearance
    - title_footer
    - sorting_pruning
    - col_counts

  - title: \{rtables\} Concepts
    contents:
    - subsetting_tables
    - split_functions
    - format_precedence
    - tabulation_concepts
    - introspecting_tables

  - title: Advanced Usage
    contents:
    - advanced_usage
    - example_analysis_coxreg

  - title: Other
    contents:
    - manual_table_construction
    - tabulation_dplyr

  - title: Developer Guide
    desc: Articles intended for developer use only.
    contents:
    # *REF1* Dev Guide items
    - dev-guide/dg_split_machinery
    - dev-guide/dg_tabulation
    - dev-guide/dg_table_hierarchy
    - dev-guide/dg_printing
    - dev-guide/dg_debug_rtables
    - dev-guide/dg_notes

reference:
  - title: Argument Conventions
    desc: The following dummy functions are unexported and used to document argument conventions in the framework.
    contents:
    - lyt_args
    - constr_args
    - compat_args
    - gen_args
    - sf_args

  - title: Layout and Tabulation
    desc: Functions for declaring layout and tabulation
    contents:
    - qtable
    - build_table
    - basic_table
    - analyze
    - append_topleft
    - split_cols_by
    - add_colcounts
    - split_rows_by
    - summarize_row_groups
    - split_cols_by_multivar
    - split_rows_by_multivar
    - analyze_colvars
    - split_cols_by_cuts
    - add_overall_col
    - add_existing_table
    - formatters::table_inset

  - title: Tabulation Utility Functions
    desc: Functions that are useful to be used with the `analyze*` functions.
    contents:
    - in_rows
    - additional_fun_params
    - simple_analysis
    - make_afun
    - list_wrap_x
    - spl_context
    - spl_context_to_disp_path
    - counts_wpcts

  - title: Split Functions
    contents:
    - add_overall_level
    - remove_split_levels
    - keep_split_levels
    - add_combo_levels
    - drop_split_levels
    - drop_and_remove_levels
    - reorder_split_levels
    - trim_levels_in_group
    - trim_levels_to_map
    - custom_split_funs
    - do_base_split

  - title: Custom Split Functions
    contents:
    - make_split_fun
    - drop_facet_levels
    - trim_levels_in_facets
    - add_combo_facet
    - make_split_result
    - spl_variable

  - title: Cell Formatting related Functions
    desc: cell formatting.
    contents:
    - format_rcell
    - value_formats

  - title: Table Structure Information
    contents:
    - dim,VTableNodeInfo-method
    - row_paths
    - row_paths_summary
    - table_structure
    - table_shell
    - formatters::make_row_df
    - make_col_df

  - title: Layout Structure Information
    contents:
    - vars_in_layout
    - coltree_structure

  - title: Access and Modify
    contents:
    - cell_values
    - top_left
    - rbind
    - cbind_rtables
    - asvec
    - brackets
    - clear_indent_mods
    - head
    - section_div
    - colcount_visible
    - facet_colcount
    - facet_colcounts_visible<-
    - rm_all_colcounts

  - title: Validating and Fixing Table Structure
    contents:
    - validate_table_struct
    - sanitize_table_struct
    - find_degen_struct

  - title: Sorting and Pruning
    contents:
    - prune_table
    - all_zero_or_na
    - trim_rows
    - sort_at_path
    - cont_n_allcols

  - title: Compatibility Layer
    desc: These functions provide some backwards compatibility to the previous
          (pre 2021) `rtables` framework.
    contents:
    - rtable
    - rrow
    - rcell
    - rheader
    - rtablel
    - rrowl
    - indent
    - df_to_tt


  - title: Output Functions
    desc: These functions create ascii or html representations of the table
    contents:
    - as_html
    - starts_with("export_as")
    - tt_to_flextable
    - tostring
    - get_formatted_cells
    - path_enriched_df

  - title: Utility Functions
    desc: utility functions
    contents:
    - Viewer
    - compare_rtables
    - indent_string
    - is_rtable

  - title: Pagination
    desc: Pagination related functionality
    contents:
    - paginate_table
    - formatters::make_row_df
    - make_col_df

  - title: TableTree Framework Accessor Functions
    contents:
    - content_table
    - tree_children
    - collect_leaves
    - obj_avar
    - no_colinfo
    - clayout
    - horizontal_sep
    - formatters::table_inset
    - formatters::main_title
    - top_left
    - formatters::obj_name

  - title: TableTree Framework Constructors and S4 Classes
    desc: S4 classes and constructors
    contents:
    - manual_cols
    - CellValue
    - ends_with("Split")
    - ends_with("class")
    - ends_with("Row")

  - title: Pathing Related Functions
    desc: Pathing and insertion related functions
    contents:
    - label_at_path
    - tt_at_path
    - insert_row_at_path

  - title: Referential Footnotes
    desc: Functions related to referential footnotes
    contents:
    - row_footnotes
    - update_ref_indexing

  - title: Result Data Frame Functions
    desc: Functions for generating result data frames from rtables TableTree objects
    contents:
    - as_result_df
    - result_df_specs

  - title: internal
    desc: Internal documented methods
    contents:
    - internal_methods
    - formatters_methods
    - matrix_form,VTableTree-method
    - length,CellValue-method
    - names,VTableNodeInfo-method
    - insert_rrow