_pkgdown.yml

url: https://bristolmyerssquibb.github.io/blockr/

home:
  title: Building blocks for data manipulation and visualization operations.

template:
  light-switch: true
  bootstrap: 5
  bslib:
    info: "#E6F2FD"
    pkgdown-nav-height: 100px
  includes:
    in_header: >
      <link href ="https://raw.githubusercontent.com/rstudio/bslib/main/inst/components/dist/card/card.min.js">
      <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@latest/font/bootstrap-icons.css">

navbar:
 components:
   articles:
    text: Developer guides
    menu:
    - text: Data blocks
      href: articles/data-blocks.html
    - text: Block registry
      href: articles/registry.html
    - text: How to create a plot block?
      href: articles/plot-block.html
    - text: How to create a new field?
      href: articles/new-field.html
    - text: More examples
      href: articles/blockr-examples.html
    - text: Internals
      href: articles/internals.html

reference:
- title: Fields core elements
  desc: Functions to build fields
  contents: 
  - "`new_field`"
  - "`is_field`"
  - "`initialize_field`"
  - "`is_initialized`"
  - "`validate_field`"
  - "`update_field`"
  - "`value`"
  - "`values`"
  - "`value<-`"

- title: Fields elements
  desc: Fields are translated into shiny inputs. They are part of blocks.
  contents:
  - "`new_string_field`"
  - "`new_select_field`"
  - "`new_switch_field`"
  - "`new_numeric_field`"
  - "`new_submit_field`"
  - "`new_upload_field`"
  - "`new_filesbrowser_field`"
  - "`new_variable_field`"
  - "`new_range_field`"
  - "`new_hidden_field`"
  - "`new_list_field`"
  - "`new_result_field`"
  - "`new_keyvalue_field`"

- title: Blocks core elements
  desc: Functions to build blocks
  contents: 
  - "`new_block`"
  - "`is_block`"
  - "`initialize_block`"
  - "`is_initialized`"
  - "`generate_code`"
  - "`evaluate_block`"
  - "`update_fields`"
  - "`layout`"
  - "`create_block`"

- title: Blocks
  desc: Blocks contain field. They return a dataframe
  contents: 
  - "`new_dataset_block`"
  - "`new_upload_block`"
  - "`new_filesbrowser_block`"
  - "`new_parser_block`"
  - "`new_csv_block`"
  - "`new_rds_block`"
  - "`new_json_block`"
  - "`new_xpt_block`"
  - "`new_result_block`"
  - "`new_filter_block`"
  - "`new_select_block`"
  - "`new_summarize_block`"
  - "`new_arrange_block`"
  - "`new_group_by_block`"
  - "`new_join_block`"
  - "`new_head_block`"
  - "`new_mutate_block`"

- title: Stack
  desc: Stack contains multiple block.
  contents:
  - "`new_stack`"
  - "`is_stack`"
  - "`get_stack_name`"
  - "`set_stack_name`"
  - "`get_stack_title`"
  - "`set_stack_title`"
  - "`block_combiner`"
  - "`add_block`"
  - "`serve_stack`"

- title: Workspace
  desc: Workspace contains multiple stacks.
  contents:
  - "`set_workspace`"
  - "`is_workspace`"
  - "`restore_workspace`"
  - "`get_workspace`"
  - "`add_workspace_stack`"
  - "`get_workspace_stack`"
  - "`get_workspace_stacks`"
  - "`set_workspace_stack`"
  - "`rm_workspace_stacks`"
  - "`rm_workspace_stack`"
  - "`get_workspace_title`"
  - "`set_workspace_title`"
  - "`get_workspace_settings`"
  - "`set_workspace_settings`"
  - "`list_workspace_stacks`"
  - "`serve_workspace`"

- title: Registry
  desc: Registry of blocks
  contents:
  - "`available_blocks`"
  - "`block_name`"
  - "`block_descr`"
  - "`register_block`"
  - "`register_blocks`"
  - "`unregister_blocks`"
  - "`construct_block`"
  - "`get_compatible_blocks`"
  - "`get_registry`"
  - "`add_block_ui`"
  - "`add_block_server`"

- title: Server utilities
  desc: Shiny server elements
  contents:
  - starts_with("server")
  - ends_with("server")
  - "`handle_remove`"
  - "`init`"

- title: UI utilities
  desc: Shiny ui elements
  contents:
  - starts_with("ui")
  - ends_with("ui")
  - "`block_body`"
  - "`block_code`"
  - "`block_header`"
  - "`data_info`"
  - "`remove_button`"
  - "`inject_remove_button`"
  - "`stack_header`"
  - "`input_ids`"
  - starts_with("icon")
  - ends_with("icon")
  - "`useBlockr`"
  - "`off_canvas`"
  - "`create_app_link`"

- title: Serialisation utils
  desc: To save and restore a workspace
  contents:
  - "`blockr_serialize`"
  - "`blockr_deserialize`"
  - "`from_json`"
  - "`to_json`"

- title: Workspace locking
  desc: Utils to lock a workspace
  contents:
  - "`lock`"
  - "`unlock`"
  - "`toggle_lock`"
  - "`is_locked`"
  - "`observe_lock`"
  - "`init_lock`"

- title: Logging utils
  desc: Track log messages
  contents:
  - "`write_log`"
  - "`log_fatal`"
  - "`log_error`"
  - "`log_warn`"
  - "`log_info`"
  - "`log_debug`"
  - "`log_trace`"
  - "`as_log_level`"
  - "`cnd_logger`"
  - "`cat_logger`"

news:
 releases:
 - text: "blockr 0.0.2.9031"
 - text: "blockr 0.0.2"
 - text: "blockr 0.0.1.9000"