pandasx / ReadCsvOptions
Interface: ReadCsvOptions
Defined in: src/io/csv.ts:23
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
chunksize? | number | Return an iterator of DataFrames with this many rows each. | src/io/csv.ts:67 |
comment? | string | Lines starting with this character are ignored. | src/io/csv.ts:60 |
compression? | Compression | 'infer' (default, from the extension or magic bytes), 'gzip', 'zstd', 'zip', ... | src/io/csv.ts:65 |
dateFormat? | string | strptime format for parseDates. | src/io/csv.ts:43 |
decimal? | string | Decimal mark, e.g. ',' for European files. | src/io/csv.ts:55 |
dtype? | DType | Record<string, DType> | Force dtypes, globally or per column. | src/io/csv.ts:35 |
encoding? | BufferEncoding | - | src/io/csv.ts:63 |
escapechar? | string | Character escaping the quote / separator inside fields. | src/io/csv.ts:58 |
falseValues? | readonly string[] | - | src/io/csv.ts:51 |
header? | number | null | Row number of the header, or null when the file has none (default 0). | src/io/csv.ts:27 |
indexCol? | string | number | readonly (string | number)[] | Column(s) (name or position) to use as the index. | src/io/csv.ts:31 |
keepDefaultNa? | boolean | Include the default NA strings (default true). | src/io/csv.ts:39 |
names? | readonly string[] | Column names to use (implies no header unless header is given). | src/io/csv.ts:29 |
naValues? | readonly string[] | Extra strings recognised as NA. | src/io/csv.ts:37 |
nrows? | number | Read at most this many data rows. | src/io/csv.ts:45 |
onBadLines? | "error" | "skip" | "warn" | 'error' (default), 'skip' or 'warn' for rows with too many fields. | src/io/csv.ts:62 |
parseDates? | readonly string[] | Columns to parse as datetimes. | src/io/csv.ts:41 |
quotechar? | string | - | src/io/csv.ts:56 |
sep? | string | Field delimiter (default ','); '\s+' splits on runs of whitespace. | src/io/csv.ts:25 |
skipfooter? | number | Drop this many lines at the end. | src/io/csv.ts:49 |
skiprows? | number | readonly number[] | Skip this many lines at the start (or the listed line numbers). | src/io/csv.ts:47 |
thousands? | string | Thousands separator to strip from numbers, e.g. ','. | src/io/csv.ts:53 |
trueValues? | readonly string[] | - | src/io/csv.ts:50 |
usecols? | readonly string[] | Only load these columns. | src/io/csv.ts:33 |