Skip to content

Commit 099312b

Browse files
committed
Update api-docs.txt
1 parent 3b5a559 commit 099312b

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

pointblank/data/api-docs.txt

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5399,9 +5399,12 @@ DataScan(data: 'FrameT | Any', tbl_name: 'str | None' = None) -> None
53995399
The fractions are calculated as the ratio of the measure to the total number of rows in the
54005400
dataset.
54015401

5402-
Statistics for Numerical Columns
5403-
--------------------------------
5404-
For numerical columns, the following descriptive statistics are provided:
5402+
Statistics for Numerical and String Columns
5403+
-------------------------------------------
5404+
For numerical and string columns, several statistical measures are provided. Please note that
5405+
for string columms, the statistics are based on the lengths of the strings in the column.
5406+
5407+
The following descriptive statistics are provided:
54055408

54065409
- `mean`: the mean of the column
54075410
- `std_dev`: the standard deviation of the column
@@ -5417,18 +5420,12 @@ DataScan(data: 'FrameT | Any', tbl_name: 'str | None' = None) -> None
54175420
- `max`: the maximum value in the column
54185421
- `iqr`: the interquartile range of the column
54195422

5420-
Statistics for String Columns
5421-
-----------------------------
5422-
For string columns, the following statistics are provided:
5423-
5424-
- `mode`: the mode of the column
5425-
5426-
Statistics for Datetime Columns
5427-
-------------------------------
5428-
For datetime columns, the following statistics are provided:
5423+
Statistics for Date and Datetime Columns
5424+
----------------------------------------
5425+
For date/datetime columns, the following statistics are provided:
54295426

5430-
- `min_date`: the minimum date in the column
5431-
- `max_date`: the maximum date in the column
5427+
- `min`: the minimum date/datetime in the column
5428+
- `max`: the maximum date/datetime in the column
54325429

54335430
Returns
54345431
-------

0 commit comments

Comments
 (0)