_pkgdown.yml

url: https://danchaltiel.github.io/crosstable/
destination: docs


home:
  title: An R package Crosstables for descriptive analyses
  description: Thoroughly describe all your datasets with useful metrics, using only a few lines of code.


template:
  bootstrap: 5
  params:
    bootswatch: flatly
  opengraph:
    image:
      src: apple-touch-icon-180x180.png
      alt: "Crosstable: easy dataset description"
    twitter:
      creator: "@DanChaltiel"
      card: summary
  includes:
    in_header: |
       <!-- Global site tag (gtag.js) - Google Analytics -->
       <script async src="https://www.googletagmanager.com/gtag/js?id=G-F1ZSXB74Z9"#' ></script>
       <script>
         window.dataLayer = window.dataLayer || [];
         function gtag(){dataLayer.push(arguments);}
         gtag('js', new Date());
         gtag('config', 'G-F1ZSXB74Z9');
       </script>


navbar:
  structure:
    left:  [home, articles, reference, news]
    right: [docsearch, twitter, github]
  components:
    twitter:
        icon: "fab fa-twitter fa-lg"
        href: http://twitter.com/DanChaltiel
    articles:
      text: Articles
      menu:
      - text: Get started
        href: articles/crosstable.html
      - text: Select columns
        href: articles/crosstable-selection.html
      - text: Automatic reporting
        href: articles/crosstable-report.html
      - text: Using `percent_pattern`
        href: articles/percent_pattern.html


articles:
- title: Articles
  navbar: ~
  contents:
  - crosstable
  - crosstable-selection
  - crosstable-report
  - percent_pattern


reference:
- title: "Main function"
- contents:
  - crosstable
  - crosstable_options
  - crosstable_peek_options
  - crosstable_reset_options
- title: "Datasets"
  desc: "Standard datasets, modified to have labels, characters, and factors"
- contents:
  - iris2
  - mtcars2
- title: "Labelling"
  desc: "Handle label attributes (compatible with Hmisc, expss, haven...)"
- contents:
  - import_labels
  - set_label
  - get_label
  - remove_labels
  - apply_labels
  - rename_dataframe_with_labels
  - clean_names_with_labels
- title: "Post-processing"
  desc: "Modify an already built crosstable"
- contents:
  - transpose_crosstable
  - pivot_crosstable
- title: "Summary functions"
  desc: "Summarise numeric variables"
- contents:
  - summaryFunctions
  - cross_summary
  - na
  - "N"
- title: "Visualization"
  desc: "Visualize a crosstable in various formats"
- contents:
  - as_gt.crosstable
  - as_workbook
  - as_flextable
- title: "Officer helpers"
  desc: "Used in cooperation with the `officer` package"
- contents:
  - starts_with("body_")
  - docx_bookmarks2
  - write_and_open
  - generate_autofit_macro
- title: "Utils"
  desc: "Practical functions for various purposes"
- contents:
  - get_percent_pattern
  - format_fixed
  - compact
  - plim
  - confint_numeric
  - narm
  - is.crosstable
  - peek
- title: "Effects and tests"
- subtitle: "Default parameters"
- contents:
  - crosstable_effect_args
  - crosstable_test_args
- subtitle: "Effects"
- contents:
  - display_effect
  - starts_with("effect_")
- subtitle: "Tests"
- contents:
  - display_test
  - starts_with("test_")