Liking cljdoc? Tell your friends :D

datajure.clay

Rich Clay/Kindly notebook viewers for Datajure datasets and expressions.

Clay integration uses the Kindly convention — values are annotated with :kind/hiccup metadata so any Kindly-compatible tool (Clay, Portal, etc.) renders them as rich HTML.

Two usage modes:

  1. Explicit wrapping (always works, no install step):

    (dc/view ds) ;; rich dataset table (dc/view-expr #dt/e (/ :mass 1000)) ;; expression display (dc/view-describe (du/describe ds)) ;; enhanced describe

  2. Auto-rendering via install! (registers Kindly advisor):

    (dc/install!) ;; Now all datasets and #dt/e exprs auto-render in Clay notebooks

Usage in a Clay notebook:

(ns my-notebook (:require [datajure.clay :as dc] [datajure.core :as core] [scicloj.clay.v2.api :as clay])) (dc/install!)

(core/dt ds :by [:species] :agg {:n core/N})

Rich Clay/Kindly notebook viewers for Datajure datasets and expressions.

Clay integration uses the Kindly convention — values are annotated with
:kind/hiccup metadata so any Kindly-compatible tool (Clay, Portal, etc.)
renders them as rich HTML.

Two usage modes:

1. Explicit wrapping (always works, no install step):

   (dc/view ds)                         ;; rich dataset table
   (dc/view-expr #dt/e (/ :mass 1000))  ;; expression display
   (dc/view-describe (du/describe ds))   ;; enhanced describe

2. Auto-rendering via install! (registers Kindly advisor):

   (dc/install!)
   ;; Now all datasets and #dt/e exprs auto-render in Clay notebooks

Usage in a Clay notebook:

  (ns my-notebook
    (:require [datajure.clay :as dc]
              [datajure.core :as core]
              [scicloj.clay.v2.api :as clay]))
  (dc/install!)

  (core/dt ds :by [:species] :agg {:n core/N})
raw docstring

datajure-advisorclj

(datajure-advisor {:keys [value]})

Kindly advisor that assigns :kind/hiccup to Datajure types. Returns a vector of [kind] pairs when the value is recognized, nil otherwise. Checks in order: describe output, dataset, #dt/e expr.

Kindly advisor that assigns :kind/hiccup to Datajure types.
Returns a vector of [kind] pairs when the value is recognized,
nil otherwise. Checks in order: describe output, dataset, #dt/e expr.
sourceraw docstring

install!clj

(install!)

Register Datajure custom rendering with Clay/Kindly.

This registers a Kindly advisor that automatically renders:

  • tech.v3.dataset datasets as rich HTML tables with column types
  • #dt/e AST nodes as readable expressions with metadata
  • du/describe output with conditional formatting

Call at the top of your Clay notebook after requiring this namespace.

Register Datajure custom rendering with Clay/Kindly.

This registers a Kindly advisor that automatically renders:
- tech.v3.dataset datasets as rich HTML tables with column types
- #dt/e AST nodes as readable expressions with metadata
- du/describe output with conditional formatting

Call at the top of your Clay notebook after requiring this namespace.
sourceraw docstring

viewclj

(view dataset)
(view dataset opts)

Render a dataset as a rich HTML table via Kindly. Returns a Hiccup value annotated with :kind/hiccup metadata. Options: :max-rows, :max-cols (same as clerk/dataset->hiccup).

Render a dataset as a rich HTML table via Kindly.
Returns a Hiccup value annotated with :kind/hiccup metadata.
Options: :max-rows, :max-cols (same as clerk/dataset->hiccup).
sourceraw docstring

view-describeclj

(view-describe desc-ds)

Render a du/describe result as an enhanced HTML table via Kindly. Returns a Hiccup value annotated with :kind/hiccup metadata.

Render a du/describe result as an enhanced HTML table via Kindly.
Returns a Hiccup value annotated with :kind/hiccup metadata.
sourceraw docstring

view-exprclj

(view-expr node)

Render a #dt/e expression AST as rich HTML via Kindly. Returns a Hiccup value annotated with :kind/hiccup metadata.

Render a #dt/e expression AST as rich HTML via Kindly.
Returns a Hiccup value annotated with :kind/hiccup metadata.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close