_pkgdown.yml

url: https://descriptr.rsquaredacademy.com
template:
  bootstrap: 5

authors:
  Aravind Hebbali:
    href: https://www.aravindhebbali.com

templates:
  params:
    bootswatch: cerulean
    
navbar:
  title: "descriptr"
  type: inverse
  left:
    - text: "Home"
      href: index.html
    - text: "Guides"
      menu:
        - text: "Continuous Data"
          href: articles/continuous-data.html
        - text: "Categorical Data"
          href: articles/categorical-data.html
        - text: "Visualization"
          href: articles/visualization.html
    - text: "Reference"
      menu:
        - text: "Functions"
          href: reference/index.html
        - text: "News"
          href: news/index.html
  right:
    - icon: fa-github
      href: https://github.com/rsquaredacademy/descriptr
    

home:
  links:
    - text: Our R packages
      href: https://pkgs.rsquaredacademy.com
    - text: Read our blog
      href: https://blog.rsquaredacademy.com
    - text: Our ebooks
      href: https://ebooks.rsquaredacademy.com
    - text: Online courses
      href: https://www.rsquaredacademy.com

reference:
- title: Shiny App
  desc: >
    Launches shiny app for interactive exploration of data sets.
  contents:
  - ds_launch_shiny_app
      
- title: Data Screening
  desc: >
    The `screener()` function will screen data frames and return details such
    as variable names, class, levels and missing values. The `plot.screener()`
    creates bar plots to visualize % of missing observations for each variable
    in a data frame.
  contents:
  - ds_screener

- title: Continuous Data
  desc: >
    The following functions ease the process of generating and visualizing
    descriptive statistics for continuous data.
  contents:
  - ds_auto_summary_stats
  - ds_extreme_obs
  - ds_freq_table
  - ds_measures_location
  - ds_measures_symmetry
  - ds_measures_variation
  - ds_percentiles
  - ds_summary_stats
  - ds_tidy_stats
  
- title: Categorical Data
  desc: >
    The following functions ease the process of generating and visualizing
    descriptive statistics for categorical data. 
  contents:
  - ds_auto_cross_table
  - ds_auto_freq_table
  - ds_cross_table
  - ds_freq_table

- title: Grouped Summary 
  desc: >
    The following functions generate grouped summary statistics.
  contents:
  - ds_auto_group_summary
  - ds_group_summary
  - ds_group_summary_interact

- title: Visualization
  desc: >
    The following functions generate plots for different data types.
  contents:
  - ds_plot_bar
  - ds_plot_bar_grouped
  - ds_plot_bar_stacked
  - ds_plot_box_group
  - ds_plot_box_single
  - ds_plot_density
  - ds_plot_histogram
  - ds_plot_scatter
 
- title: Other Functions
  desc: >
    A set of functions used to generate `summary_stats`.
  contents:  
  - ds_css
  - ds_cvar
  - ds_gmean
  - ds_hmean
  - ds_kurtosis
  - ds_mdev
  - ds_mode
  - ds_range
  - ds_rindex
  - ds_skewness
  - ds_std_error
  - ds_tailobs

- title: Data
  desc: >
    descriptr comes with a built-in dataset `hsb` which is used to
    illustrate the functions as well as for running tests.
  contents:
  - hsb
  - mtcarz