schema.sampleargs.md
February 26, 2024 ยท View on GitHub
Home > @datashaper/schema > SampleArgs
SampleArgs interface
Signature:
export interface SampleArgs
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| emitRemainder? | boolean | (Optional) Whether to preserve and emit the non-sampled records via the 'remainder' output port. | |
| proportion? | number | (Optional) If table size is unknown ahead of time, specify a proportion of rows to sample. If size is specified, it will be used instead, otherwise computed from this proportion using the table.numRows() | |
| seed? | number | (Optional) The randomization seed to use for sampling to ensure stable sampling. | |
| size? | number | (Optional) Number of rows to sample from the table. This takes precedence over proportion. |