CLI Documentation

The input argument is a path to a tsv file.

tsvalid

Validate a tsv file.

Example:

tsvalid validate table.tsv

# noqa: DAR101

tsvalid [OPTIONS] INPUT

Options

--skip <skip>

You can skip TSValid checks, by either naming them directly or defining regular expression patterns to match groups of checks. For example –skip E2 skips the E2 check, and –skip W.* skips all checks starting with a W.

--encoding <encoding>

The encoding defines how the TSV file should be interpreted as a string.

--comment <comment>

Many TSV files use comments, typically a hash (#) to denote that anything following a # symbol should be ignored. If a comment symbol is supplied, and a row starts with that symbol, no QC checks are run on that row.

--summary

If true, prints an error summary at the end of validation.

Default

False

Arguments

INPUT

Required argument