_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
    ganalytics: UA-171705639-1
  opengraph:
    image:
      src: apple-touch-icon-180x180.png
      alt: "Crosstable: easy dataset description"
    twitter:
      creator: "@DanChaltiel"
      card: summary

 
navbar:
  structure:
    left:  [home, intro, articles, reference, news]
    right: [docsearch, twitter, github]
  components:
    twitter:
        icon: "fab fa-twitter fa-lg"
        href: http://twitter.com/DanChaltiel


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


reference:
- title: "Main function"
- contents: 
  - crosstable
  - crosstable_options
  - crosstable_peek_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
- 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: 
  - format_fixed
  - compact
  - plim
  - confint_numeric
  - 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_")