Liking cljdoc? Tell your friends :D

criterium.viewer.common.autocorrelation

Autocorrelation view helpers.

Provides functions for formatting autocorrelation data and iterating over metrics for display. Used by print and pprint viewers.

Autocorrelation view helpers.

Provides functions for formatting autocorrelation data and iterating over
metrics for display. Used by print and pprint viewers.
raw docstring

collect-classification-metricsclj

(collect-classification-metrics {:keys [classification-id autocorrelation-id]}
                                data-map)

Collect classification data for all metrics. Returns seq of [class-data acf-data mc]. Uses :classification-id to get classification analysis results, and looks up the source autocorrelation for lag-1 data.

Collect classification data for all metrics.
 Returns seq of [class-data acf-data mc].
Uses :classification-id to get classification analysis results, and looks up
the source autocorrelation for lag-1 data.
sourceraw docstring

collect-ess-metricsclj

(collect-ess-metrics {:keys [ess-id autocorrelation-id]} data-map)

Collect ESS data for all metrics. Returns seq of [ess-data acf-data mc]. Uses :ess-id to get ESS analysis results, and looks up the source autocorrelation for lag-1 data.

Collect ESS data for all metrics. Returns seq of [ess-data acf-data mc].
Uses :ess-id to get ESS analysis results, and looks up
the source autocorrelation for lag-1 data.
sourceraw docstring

displayable-patternsclj

Patterns that warrant display of pattern label and recommendations. Excludes :clean, :alternating-none, and :alternating-minor.

Patterns that warrant display of pattern label and recommendations.
Excludes :clean, :alternating-none, and :alternating-minor.
sourceraw docstring

format-anomalous-lagsclj

(format-anomalous-lags anomalous-lags lag-severities)

Format anomalous lags for display. Takes a vector of lag numbers and a map of lag -> severity. Returns a string like '1 (minor), 12 (moderate)' or nil if empty.

Format anomalous lags for display.
Takes a vector of lag numbers and a map of lag -> severity.
Returns a string like '1 (minor), 12 (moderate)' or nil if empty.
sourceraw docstring

format-detected-periodclj

(format-detected-period detected-period acf-map lag-severities)

Format detected period with ACF value and severity. Returns a string like '60 samples (r=0.35, moderate)' or nil if period is nil.

Format detected period with ACF value and severity.
Returns a string like '60 samples (r=0.35, moderate)' or nil if period
is nil.
sourceraw docstring

format-severityclj

(format-severity severity)

Format a severity keyword for display.

Format a severity keyword for display.
sourceraw docstring

pattern-labelsclj

Human-readable labels for pattern keywords.

Human-readable labels for pattern keywords.
sourceraw docstring

pattern-recommendationsclj

Recommendations for each displayable pattern.

Recommendations for each displayable pattern.
sourceraw docstring

severity-labelsclj

Human-readable labels for severity keywords.

Human-readable labels for severity keywords.
sourceraw docstring

with-autocorrelation-metricsclj

(with-autocorrelation-metrics {:keys [autocorrelation-id]} data-map f)

Helper for autocorrelation views. Calls f for each metric with acf-data. f receives acf-data and metric-config.

Helper for autocorrelation views. Calls f for each metric with acf-data.
f receives acf-data and metric-config.
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