_pkgdown.yml

url: https://davidgohel.github.io/flextable/

title: flextable

development:
  mode: auto

template:
  bootstrap: 5
  theme: breeze-light
  bootswatch: simplex
  bslib:
    pkgdown-nav-height: 100px
    base_font:
      google: "Open Sans"

home:
  links:
  - text: 'Visit <a href="https://www.ardata.fr"><img alt="ardata" src="https://www.ardata.fr/img/ardata-logo.svg" width="70"></a> website'
    href: https://www.ardata.fr

reference:
  - title: Create flextable
    desc: >
     These functions create 'flextable' objects that can be modified later.
    contents:
    - flextable
    - qflextable
    - as_flextable
    - flextable-package
  - title: Global options
    desc: >
     Reduce homogenization efforts and the number of functions to be called by
     defining formatting properties such as font, border color, number of
     decimal places displayed that should be applied by default.
    contents:
    - set_flextable_defaults
    - get_flextable_defaults
    - init_flextable_defaults
  - title: Output functions
    contents:
    - print.flextable
    - knit_print.flextable
    - body_add_flextable
    - ph_with.flextable
    - plot.flextable
    - save_as_image
    - save_as_html
    - save_as_docx
    - save_as_rtf
    - save_as_pptx
    - htmltools_value
    - gen_grob
    - plot.flextableGrob
    - to_html.flextable
    - rtf_add.flextable
    - flextable_to_rmd
    - df_printer
    - use_df_printer
    - use_model_printer
    - body_replace_flextable_at_bkm
  - title: Change visual properties
    desc: >
     Modify the visual properties of the components of a 'flextable' such
     as font color, font size, word highlighting or cell background color.
    contents:
    - style
    - align
    - bg
    - font
    - fontsize
    - italic
    - bold
    - color
    - line_spacing
    - highlight
    - padding
    - valign
    - rotate
    - tab_settings
    - empty_blanks
  - title: Management of borders
    desc: >
     The border system is based on vertical and horizontal lines which can be
     easily specified. Some additional tools are provided for specific needs.
    contents:
    - fp_border_default
    - starts_with("hline")
    - starts_with("vline")
    - border_inner
    - border_inner_h
    - border_inner_v
    - border_outer
    - border_remove
    - surround
  - title: Flextable themes
    desc:  Apply theme functions
    contents:
    - starts_with("theme_")
  - title: Add headers and footers
    desc: >
     Add header titles, comments in footers and new rows in body
     with the following functions, remove rows and columns.
    contents:
    - add_header_row
    - add_footer_row
    - add_header_lines
    - add_footer_lines
    - add_header
    - add_footer
    - separate_header
    - set_header_labels
    - set_header_df
    - set_footer_df
    - add_body
    - add_body_row
    - delete_part
    - delete_rows
    - delete_columns
  - title: Cell merging
    contents:
    - starts_with("merge_")
  - title: flextable dimensions
    contents:
    - starts_with("height")
    - set_table_properties
    - paginate
    - keep_with_next
    - width
    - hrule
    - autofit
    - fit_to_width
    - dim.flextable
    - dim_pretty
    - flextable_dim
    - dim.flextableGrob
    - nrow_part
    - ncol_keys
  - title: Define how to display the content
    desc: >
     Simple tools for formatting the content of cells such as managing the
     number of decimals, adding suffixes or prefixes and defining the
     thousands separator.
    contents:
    - starts_with("colformat_")
    - starts_with("set_formatter")
    - labelizor
  - title: Mixed and complex content
    desc: >
      How to define complex paragraphs with mixed content or to
      add images or chunks of text in existing cells.
    contents:
    - compose
    - as_paragraph
    - append_chunks
    - prepend_chunks
    - footnote
    - fp_text_default
  - title: Elements for mixed content
    desc: >
      Functions that can be called to create rich, formatted content. They are to be used
      within calls to `mk_par()`, `append_chunks()`, `prepend_chunks()` and
      possibly `set_caption()` functions.
    contents:
    - as_chunk
    - as_image
    - gg_chunk
    - plot_chunk
    - grid_chunk
    - as_b
    - as_i
    - as_sub
    - as_sup
    - as_highlight
    - colorize
    - minibar
    - linerange
    - lollipop
    - as_bracket
    - hyperlink_text
    - as_equation
    - as_word_field
  - title: Caption
    contents:
    - set_caption
  - title: miscellaneous
    contents:
    - starts_with("fmt_")
    - before
    - void
  - title: Transform objects into flextables with 'as_flextable'
    desc: >
     The `as_flextable()` function is used to transform specific objects
     into flextable objects. For example, you can transform a crosstab produced
     with the 'tables' package into a flextable which can then be formatted,
     annotated or augmented with footnotes.
    contents:
    - tabulator
    - tabulator_colnames
    - summarizor
    - starts_with("as_flextable")
    - continuous_summary
    - as_grouped_data
    - proc_freq
    - shift_table


navbar:
  title: flextable
  type: default
  left:
  - text: Function reference
    href: reference/index.html
  - text: User Documentation
    href: https://ardata-fr.github.io/flextable-book/

footer:
  structure:
    left: legal
  components:
    legal: proudly brought to you by <a href="https://www.ardata.fr"><img alt="ardata" src="https://www.ardata.fr/img/ardata-logo.svg" width="70"></a>


authors:
  David Gohel:
    href: https://www.ardata.fr
  Rémi Thériault:
    href: https://remi-theriault.com