tablecloth.api.group-by — scicloj/tablecloth 5.00-beta-5

as-regular-dataset clj

group-by clj

(group-by ds grouping-selector)

(group-by ds
          grouping-selector
          {:keys [select-keys result-type]
           :or {result-type :as-dataset select-keys :all}
           :as options})

Group dataset by:

• column name
• list of columns
• map of keys and row indexes
• function getting map of values

Options are:

• select-keys - when grouping is done by function, you can limit fields to a select-keys seq.
• result-type - return results as dataset (:as-dataset, default) or as map of datasets (:as-map) or as map of row indexes (:as-indexes) or as sequence of (sub)datasets
• other parameters which are passed to dataset fn

When dataset is returned, meta contains :grouped? set to true. Columns in dataset:

• name - group name
• group-id - id of the group (int)
• data - group as dataset

grouped? clj

(grouped? ds)

Is dataset represents grouped dataset (result of group-by)?

groups->map clj

(groups->map ds)

Convert grouped dataset to the map of groups

groups->seq clj

(groups->seq ds)

mark-as-group clj

(mark-as-group ds)

Add grouping tag

process->ungroup clj

(process->ungroup ds process-fn)

(process->ungroup ds
                  process-fn
                  {:keys [order? add-group-as-column add-group-id-as-column
                          separate? dataset-name parallel?]
                   :or {separate? true}})

process-group-data clj

(process-group-data ds f)

(process-group-data ds f parallel?)

ungroup clj

(ungroup ds)

(ungroup ds
         {:keys [order? add-group-as-column add-group-id-as-column separate?
                 dataset-name parallel?]
          :or {separate? true}})

Concat groups into dataset.

When add-group-as-column or add-group-id-as-column is set to true or name(s), columns with group name(s) or group id is added to the result.

Before joining the groups groups can be sorted by group name.

unmark-group clj

(unmark-group ds)

Remove grouping tag