Commands frame/bin_column¶
Classify data into user-defined groups.
POST /v1/commands/¶
GET /v1/commands/:id¶
Request¶
Route
POST /v1/commands/
Body
name: | frame/bin_column |
---|---|
arguments: | frame : Frame
column_name : unicode
cutoffs : list
include_lowest : bool (default=None)
strict_binning : bool (default=None)
bin_column_name : unicode (default=None)
|
Headers
Authorization: test_api_key_1
Content-type: application/json
Description
Summarize rows of data based on the value in a single column by sorting them into bins, or groups, based on a list of bin cutoff points.
Notes
- Unicode in column names is not supported and will likely cause the drop_frames() method (and others) to fail!
- Bins IDs are 0-index, in other words, the lowest bin number is 0.
- The first and last cutoffs are always included in the bins.
When include_lowest is
True
, the last bin includes both cutoffs. When include_lowest isFalse
, the first bin (bin 0) includes both cutoffs.
Response¶
Status
200 OK
Body
Returns information about the command. See the Response Body for Get Command here below. It is the same.