| Type: | Package |
| Title: | API Wrapper for Altadata.io |
| Version: | 0.1.1 |
| Maintainer: | Emre Durukan <emredurukan@altadata.io> |
| Description: | Functions for interacting directly with the 'ALTADATA' API. With this R package, developers can build applications around the 'ALTADATA' API without having to deal with accessing and managing requests and responses. 'ALTADATA' is a curated data marketplace for more information go to https://www.altadata.io. |
| Imports: | httr (≥ 0.6.1), jsonlite (≥ 0.9.14) |
| Suggests: | testthat (≥ 0.10.0), roxygen2 |
| Depends: | R (≥ 2.15.0) |
| License: | MIT + file LICENSE |
| URL: | https://github.com/altabering/altadata-r |
| Encoding: | UTF-8 |
| LazyData: | true |
| RoxygenNote: | 7.1.1 |
| NeedsCompilation: | no |
| Packaged: | 2020-12-03 11:09:49 UTC; emredurukan |
| Author: | Emre Durukan [aut, cre], ALTADATA Inc. [cph] |
| Repository: | CRAN |
| Date/Publication: | 2020-12-07 08:50:02 UTC |
Set ALTADATA API key
Description
Set ALTADATA API key
Usage
aldatata.api_key(api_key)
Arguments
api_key |
Optionally passed parameter to set Altadata |
Value
Returns invisibly the currently set api_key.
Examples
## Not run:
aldatata.api_key('foobar')
## End(Not run)
In condition by given column and value list
Description
In condition by given column and value list
Usage
altadata.condition_in(condition_column, condition_value)
Arguments
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Value
Nothing just set the in condition parameters
Examples
## Not run:
altadata.condition_in("province_state", c("Utah", "Alabama"))
## End(Not run)
Not in condition by given column and value list
Description
Not in condition by given column and value list
Usage
altadata.condition_not_in(condition_column, condition_value)
Arguments
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Value
Nothing just set the not in condition parameters
Examples
## Not run:
altadata.condition_not_in("province_state", c("Utah", "Alabama"))
## End(Not run)
Equal condition by given column and value in the retrieve data process
Description
Equal condition by given column and value in the retrieve data process
Usage
altadata.equal(condition_column, condition_value)
Arguments
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Value
Nothing just set the equal condition parameters
Examples
## Not run:
altadata.equal("province_state", "Alabama")
## End(Not run)
Initialize retrieve data process
Description
Initialize retrieve data process
Usage
altadata.get_data(product_code, limit)
Arguments
product_code |
data product code |
limit |
number of rows you want to retrieve |
Value
Nothing just set the initial parameters
Examples
## Not run:
altadata.get_data("co_10_jhucs_03", limit = 50)
## End(Not run)
Get data header as a vector
Description
Get data header as a vector
Usage
altadata.get_header(product_code)
Arguments
product_code |
data product code |
Value
vector object
Examples
## Not run:
aldatata.api_key('YOUR_API_KEY')
altadata.get_header("co_10_jhucs_03")
## End(Not run)
Greater than condition by given column and value
Description
Greater than condition by given column and value
Usage
altadata.greater_than(condition_column, condition_value)
Arguments
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Value
Nothing just set the greater than condition parameters
Examples
## Not run:
altadata.greater_than("mortality_rate", 2)
## End(Not run)
Greater than equal condition by given column and value
Description
Greater than equal condition by given column and value
Usage
altadata.greater_than_equal(condition_column, condition_value)
Arguments
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Value
Nothing just set the greater than equal condition parameters
Examples
## Not run:
altadata.greater_than_equal("mortality_rate", 3)
## End(Not run)
Less than condition by given column and value
Description
Less than condition by given column and value
Usage
altadata.less_than(condition_column, condition_value)
Arguments
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Value
Nothing just set the less than condition parameters
Examples
## Not run:
altadata.less_than("mortality_rate", 2)
## End(Not run)
Less than equal condition by given column and value
Description
Less than equal condition by given column and value
Usage
altadata.less_than_equal(condition_column, condition_value)
Arguments
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Value
Nothing just set the less than equal condition parameters
Examples
## Not run:
altadata.less_than_equal("mortality_rate", 3)
## End(Not run)
Get customer subscription info
Description
Get customer subscription info
Usage
altadata.list_subscription()
Value
dataframe object
Examples
## Not run:
altadata.list_subscription()
## End(Not run)
Fetch data with configurations given before
Description
Fetch data with configurations given before
Usage
altadata.load()
Value
dataframe object
Examples
## Not run:
aldatata.api_key('YOUR_API_KEY')
altadata.get_data("co_10_jhucs_03", limit = 50)
altadata.load()
## End(Not run)
Not equal condition by given column and value
Description
Not equal condition by given column and value
Usage
altadata.not_equal(condition_column, condition_value)
Arguments
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Value
Nothing just set the not equal condition parameters
Examples
## Not run:
altadata.not_equal("province_state", "Utah")
## End(Not run)
Select specific columns in the retrieve data process
Description
Select specific columns in the retrieve data process
Usage
altadata.select(selected_columns)
Arguments
selected_columns |
list of columns to select |
Value
Nothing just set the select parameters
Examples
## Not run:
altadata.select(c("reported_date", "province_state", "mortality_rate"))
## End(Not run)
Sort data by given column and method in the retrieve data process
Description
Sort data by given column and method in the retrieve data process
Usage
altadata.sort(order_column, order_method = "asc")
Arguments
order_column |
column to which the order is applied |
order_method |
sorting method. Posibble values: asc or desc |
Value
Nothing just set the sort parameters
Examples
## Not run:
altadata.sort("province_state", order_method = "desc")
## End(Not run)