Validate (chamois validate)#

usage: chamois validate [-h] -f FEATURES -c CLASSES [-m MODEL]
                        [--min-class-occurrences MIN_CLASS_OCCURRENCES]
                        [--min-feature-occurrences MIN_FEATURE_OCCURRENCES]
                        [--min-class-groups MIN_CLASS_GROUPS]
                        [--min-feature-groups MIN_FEATURE_GROUPS]
                        [--min-cluster-length MIN_CLUSTER_LENGTH]
                        [--min-genes MIN_GENES] [--mismatch] -o OUTPUT
                        [--metrics METRICS] [--report REPORT]

Input#

Mandatory input files required by the command.

-f, --features

The feature table in HDF5 format to use for training the predictor.

-c, --classes

The classes table in HDF5 format to use for training the predictor.

-m, --model

The path to an alternative model to predict classes with.

Preprocessing#

Parameters controling data preprocessing, including features and labels filtering.

--min-class-occurrences

The minimum of occurences for a class to be retained.

Default: 0

--min-feature-occurrences

The minimum of occurences for a feature to be retained.

Default: 0

--min-class-groups

The minimum number of groups for a class to be retained.

Default: 5

--min-feature-groups

The minimum number of groups for a feature to be retained.

Default: 5

--min-cluster-length

The nucleotide length threshold for retaining a cluster.

Default: 0

--min-genes

The gene count threshold for retaining a cluster.

Default: 0

--mismatch

Whether to correct mismatching observations.

Default: False

Output#

Mandatory and optional outputs.

-o, --output

The path where to write the computed probabilities.

--metrics

The path to an optional metrics file to write in DVC/JSON format.

--report

An optional file where to generate a label-wise evaluation report.