_pkgdown.yml

url: https://slinghub.github.io/lancer/

template:
  bootstrap: 5
  bootswatch: flatly

reference:
  - title: General Workflow
    desc: >
      Functions used for tidy workflow
    contents:
    - create_curve_table
    - summarise_curve_table
    - evaluate_linearity
    - write_summary_excel
    - add_ggplot_panel
    - add_plotly_panel
    - view_ggplot_pdf
    - view_trellis_html
  - title: Summarise Curve Data
    desc: >
      Functions used to summarise curve data
    contents:
    - summarise_curve_table
    - summarise_curve_data
    - ends_with("_model")
    - calculate_concavity
    - calculate_gof_linear
    - calculate_mandel
    - calculate_pra_linear
    - evaluate_linearity
  - title: Plotting
    desc: >
      Functions used to plot curves and summary tables
    contents:
    - starts_with("plot_")
  - title: Cognostics Creation
    desc: >
      Functions used to convert columns to class cognostics
    contents:
    - convert_to_cog
    - create_default_cog_df
    - starts_with("update_cog")
  - title: Output in Excel
    desc: >
      Functions used to write curve summary table to Excel
    contents:
    - write_summary_excel
    - calculate_column_max_char
    - format_char_cell_colour
    - format_num_cell_colour
    - format_num_cell_style
    - mark_near_zero_columns
  - title: Output in pdf
    desc: >
      Functions used to help output `ggplots` plots to pdf
    contents:
    - view_ggplot_pdf
    - create_reg_col_vec
    - create_page_layout
  - title: Output in trellis
    desc: >
      Functions used to help output `ggplots` or `plotly` plots to trellis
    contents:
    - view_trellis_html
  - title: Validation
    desc: >
      Functions used to validate datasets
    contents:
    - starts_with("validate")
  - title: Utilities
    desc: >
      Utilities functions
    contents:
    - create_char_seq
  - title: Experiment functions
    desc: >
      Functions that are experimental
      <a href="https://lifecycle.r-lib.org/articles/stages.html">
      <img src='figures/lifecycle-experimental.svg' alt='Experimental lifecycle'/>
      </a>
    contents:
    - calculate_adl
    - calculate_adl_kroll_test
  - title: Defunct and deprecated functions
    desc: >
      Functions that are not in used (defunct) or deprecated
      <a href="https://lifecycle.r-lib.org/articles/stages.html">
      <img src='figures/lifecycle-defunct.svg' alt='Defunct lifecycle'/>
      </a>
      <a href="https://lifecycle.r-lib.org/articles/stages.html">
      <img src='figures/lifecycle-deprecated.svg' alt='Deprecated lifecycle'/>
      </a>
    contents:
    - validate_dilution_annot
    - validate_dilution_table
    - validate_dilution_data
    - validate_lipid_data_wide
    - create_dilution_table
    - summarise_dilution_data
    - summarise_dilution_table