Description Usage Arguments Value
View source: R/getFilteredRows.R
Returns a dataframe with up to 10,000 rows of a dataset after applying a term or range filter.
This is especially useful when trying to download a dataset from Numetric that has more than 10,000 rows.
This function uses the V2 version of the API.
1 2 3 | getFilteredRows(apiKey, datasetId, filterType = "term", filterField = "",
filterValue = "", customFilterValue = "", startRange = "",
endRange = "", size = 10000, includes = "", excludes = "")
|
apiKey |
The API key, in quotes. You can find the API key in the settings after logging into Numetric |
filterType |
The type of filter to apply. Options are "term", "range", "custom", or "none". Default value is "none". |
filterField |
The name of the column, in quotes, to use as a filter. This should not used when the filterType is "custom". |
filterValue |
This is only used when applying a term filter. The value in quotes, is what will be included. (If the must argument is set to "false", then this will be an exclude filter.) This should not used when the filterType is "custom". |
customFilterValue |
This is used in conjunction with a custom filterType. The format should be: "filter": "term", "field": "fieldName", "value": "value" |
startRange |
If the filterType == range, then this is a minimum numeric value or date, in quotes. If it's a date, then it should be in the format of "2017-05-30T00.00.00.000". |
endRange |
If the filterType == range, then this is a maximum numeric value or date, in quotes. If it's a date, then it should be in the format of "2017-05-30T00.00.00.000". |
size |
The maximum number of rows of data to return. The default and maximum is 10,000. |
includes |
Optional. A vector of stings listing the column names that you want to INCLUDE. The default is to include all columns. |
excludes |
Optional. A vector of stings listing the column names that you want to EXCLUDE. The default is to exclude no columns. |
bucketVar |
The name of the dataset column, in quotes, that will be used to bucket the data. |
must |
Whether the term filter is an include or excludes filter. By default it's set to "true", which is an includes filter. If set to "false", then it will be an excludes term filter. |
Returns a dataframe.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.