_pkgdown.yml

url: https://github.com/rpolars/rpolars/
reference:
  # NSE

  - title: rpolars classes
    desc: >
      Are a classsystem that extends the extendr class system (let's call it "environment classes").
      Below is the individual derived classes documented.
  - subtitle: DataFrame
    contents:
      - has_keyword("DataFrame_new")
      - has_keyword("DataFrame")
  - subtitle: LazyFrame
    contents:
      - has_keyword("LazyFrame_new")
      - has_keyword("LazyFrame")
  - subtitle: Expr
    contents:
      - has_keyword("Expr_new")
      - has_keyword("Expr")
  - subtitle: Series
    contents:
      - has_keyword("Series_new")
      - has_keyword("Series")
  - title: rpolars API and namespace
    desc: >
      rpolars api's is not exported in NAMESPACE, because it would collide badly with base R
      and other popular functions. As rpolars strive to mimic the syntax and behavior
      of py-polars, vast majority of methods are internal accessed with `$`-operator.
      `pl` is the public api of functions and class constructors. All functions, objects and methods
      needed to interact with polars are accessed via `pl$` or `object$method()`.
      `.pr` the private class methods, which always are calls to rust-polars.
      Also `rpolars:::` have lots of private R functions.
    contents:
      - has_keyword("api")
      - has_keyword("api_object")
      - has_keyword("api_private")

  - title: Internals
    desc: Internal documented functions
    contents:
      - has_keyword("internal")

  - title: everything else
    contents:
      - -has_keyword("api")
      - -has_keyword("api_object")
      - -has_keyword("api_private")
      - -has_keyword("DataFrame_new")
      - -has_keyword("DataFrame")
      - -has_keyword("LazyFrame_new")
      - -has_keyword("Expr")
      - -has_keyword("Expr_new")
      - -has_keyword("internal")