From 179e051ae677388622d8130281b613aee9fe03e2 Mon Sep 17 00:00:00 2001 From: Joel Natividad <1980690+jqnatividad@users.noreply.github.com> Date: Fri, 18 Oct 2024 09:58:50 -0400 Subject: [PATCH] `stats`: add note about validating input CSV files in case of `stats` errors [skip ci] --- src/cmd/stats.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/cmd/stats.rs b/src/cmd/stats.rs index 4896da189..6d2001d95 100644 --- a/src/cmd/stats.rs +++ b/src/cmd/stats.rs @@ -1,5 +1,9 @@ static USAGE: &str = r#" -Compute summary statistics & infers data types for each column in a CSV. +Compute summary statistics & infers data types for each column in a CSV. + +> NOTE: `stats` is heavily optimized for speed. It assumes the CSV is well-formed and +UTF-8 encoded. If you encounter problems generating stats, use `qsv validate` to confirm the +input CSV is valid. Summary statistics includes sum, min/max/range, sort order, min/max/sum/avg length, mean, standard error of the mean (SEM), stddev, variance, coefficient of variation (CV), nullcount,