_pkgdown.yml

url: https://tidypolars.etiennebacher.com/
template:
  bootstrap: 5
  bslib:
    primary: "#0B7189"
    line-height-base: 1.7

authors:
  Etienne Bacher:
    href: https://www.etiennebacher.com

navbar:
  structure:
    left:  [intro, articles, reference, news]
    right: [search, github]

reference:
  - title: Import data
    desc: |
      Functions to import data as Polars DataFrames (`read_` functions) and
      LazyFrames (`scan_` functions).
    contents:
      - from_csv
      - from_ipc
      - from_ndjson
      - from_parquet

  - title: Export data
    desc: |
      Functions to export Polars DataFrames (`write_` functions) and LazyFrames
      (`sink_` functions).
    contents:
      - starts_with("sink")
      - starts_with("write")

  - title: Functions from `dplyr`
    contents:
      - add_count.RPolarsDataFrame
      - anti_join.RPolarsDataFrame
      - arrange.RPolarsDataFrame
      - bind_cols_polars
      - bind_rows_polars
      - collect.RPolarsLazyFrame
      - count.RPolarsDataFrame
      - cross_join.RPolarsDataFrame
      - distinct.RPolarsDataFrame
      - explain.RPolarsLazyFrame
      - filter.RPolarsDataFrame
      - full_join.RPolarsDataFrame
      - group_by.RPolarsDataFrame
      - group_split.RPolarsDataFrame
      - group_vars.RPolarsDataFrame
      - inner_join.RPolarsDataFrame
      - left_join.RPolarsDataFrame
      - mutate.RPolarsDataFrame
      - pull.RPolarsDataFrame
      - relocate.RPolarsDataFrame
      - rename.RPolarsDataFrame
      - rename_with.RPolarsDataFrame
      - right_join.RPolarsDataFrame
      - rowwise.RPolarsDataFrame
      - select.RPolarsDataFrame
      - semi_join.RPolarsDataFrame
      - separate.RPolarsDataFrame
      - slice_head.RPolarsDataFrame
      - slice_tail.RPolarsDataFrame
      - slice_sample.RPolarsDataFrame
      - summarize.RPolarsDataFrame
      - ungroup.RPolarsDataFrame

  - title: Functions from `tidyr`
    contents:
      - complete.RPolarsDataFrame
      - drop_na.RPolarsDataFrame
      - fill.RPolarsDataFrame
      - pivot_longer.RPolarsDataFrame
      - pivot_wider.RPolarsDataFrame
      - replace_na.RPolarsDataFrame
      - separate.RPolarsDataFrame
      - uncount.RPolarsDataFrame
      - unite.RPolarsDataFrame

  - title: Other methods
    desc: |
      Other functions or S3 methods.
    contents:
      - as_tibble.tidypolars
      - summary.RPolarsDataFrame
      - tidypolars-options

  - title: Other Polars functions
    desc: Other Polars-specific functions (most are deprecated).
    contents:
      - describe
      - describe_plan
      - describe_optimized_plan
      - fetch
      - make_unique_id