cartodb4/crankshaft
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update signature names

Browse Source
This commit is contained in:
Andy Eschbacher 2016-10-06 09:53:22 -04:00
parent fa4e5ae686
commit c7f5c24510
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/18_outliers.md
View File

@ -25,7 +25,7 @@ Returns a boolean (true/false) depending on whether a value is above or below (o
#### Example Usage #### Example Usage
With a table `website_visits`: With a table `website_visits` and a column of the number of website visits in units of 10,000 visits:
``` ```
| id | visits_10k | | id | visits_10k |
@ -61,7 +61,7 @@ FROM website_visits
| 8 | f | 2 | | 8 | f | 2 |
``` ```
### CDB_PercentOutlier(column_values numeric[], ratio_threshold numeric, ids int[]) ### CDB_PercentOutlier(column_values numeric[], outlier_fraction numeric, ids int[])
`CDB_PercentOutlier` calculates whether or not a value falls above a given threshold based on a percentage above the mean value of the input values. `CDB_PercentOutlier` calculates whether or not a value falls above a given threshold based on a percentage above the mean value of the input values.
@ -79,7 +79,7 @@ Returns a table of the outlier classification with the following columns
| Name | Type | Description | | Name | Type | Description |
|------|------|-------------| |------|------|-------------|
| outlier | boolean | classification of whether a row is an outlier or not | | is_outlier | boolean | classification of whether a row is an outlier or not |
| rowid | int | original row id (e.g., input `cartodb_id`) of the row which has the outlier classification | | rowid | int | original row id (e.g., input `cartodb_id`) of the row which has the outlier classification |
#### Example Usage #### Example Usage
@ -111,7 +111,7 @@ Output
| f | 8 | | f | 8 |
``` ```
### CDB_StdDevOutlier(column_values numeric[], ratio_threshold numeric, ids int[], is_symmetric boolean DEFAULT true) ### CDB_StdDevOutlier(column_values numeric[], num_deviations numeric, ids int[], is_symmetric boolean DEFAULT true)
`CDB_StdDevOutlier` calculates whether or not a value falls above or below a given threshold based on the number of standard deviations from the mean. `CDB_StdDevOutlier` calculates whether or not a value falls above or below a given threshold based on the number of standard deviations from the mean.
@ -130,7 +130,7 @@ Returns a table of the outlier classification with the following columns
| Name | Type | Description | | Name | Type | Description |
|------|------|-------------| |------|------|-------------|
| outlier | boolean | classification of whether a row is an outlier or not | | is_outlier | boolean | classification of whether a row is an outlier or not |
| rowid | int | original row id (e.g., input `cartodb_id`) of the row which has the outlier classification | | rowid | int | original row id (e.g., input `cartodb_id`) of the row which has the outlier classification |
#### Example Usage #### Example Usage