Title: | API Wrapper for 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>. |
Authors: | Emre Durukan [aut, cre], ALTADATA Inc. [cph] |
Maintainer: | Emre Durukan <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.1.1 |
Built: | 2025-03-12 04:59:29 UTC |
Source: | https://github.com/altabering/altadata-r |
Set ALTADATA API key
aldatata.api_key(api_key)
aldatata.api_key(api_key)
api_key |
Optionally passed parameter to set Altadata |
Returns invisibly the currently set api_key
.
## Not run: aldatata.api_key('foobar') ## End(Not run)
## Not run: aldatata.api_key('foobar') ## End(Not run)
In condition by given column and value list
altadata.condition_in(condition_column, condition_value)
altadata.condition_in(condition_column, condition_value)
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Nothing just set the in condition parameters
## Not run: altadata.condition_in("province_state", c("Utah", "Alabama")) ## End(Not run)
## Not run: altadata.condition_in("province_state", c("Utah", "Alabama")) ## End(Not run)
Not in condition by given column and value list
altadata.condition_not_in(condition_column, condition_value)
altadata.condition_not_in(condition_column, condition_value)
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Nothing just set the not in condition parameters
## Not run: altadata.condition_not_in("province_state", c("Utah", "Alabama")) ## End(Not run)
## 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
altadata.equal(condition_column, condition_value)
altadata.equal(condition_column, condition_value)
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Nothing just set the equal condition parameters
## Not run: altadata.equal("province_state", "Alabama") ## End(Not run)
## Not run: altadata.equal("province_state", "Alabama") ## End(Not run)
Initialize retrieve data process
altadata.get_data(product_code, limit)
altadata.get_data(product_code, limit)
product_code |
data product code |
limit |
number of rows you want to retrieve |
Nothing just set the initial parameters
## Not run: altadata.get_data("co_10_jhucs_03", limit = 50) ## End(Not run)
## Not run: altadata.get_data("co_10_jhucs_03", limit = 50) ## End(Not run)
Get data header as a vector
altadata.get_header(product_code)
altadata.get_header(product_code)
product_code |
data product code |
vector object
## Not run: aldatata.api_key('YOUR_API_KEY') altadata.get_header("co_10_jhucs_03") ## End(Not run)
## 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
altadata.greater_than(condition_column, condition_value)
altadata.greater_than(condition_column, condition_value)
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Nothing just set the greater than condition parameters
## Not run: altadata.greater_than("mortality_rate", 2) ## End(Not run)
## Not run: altadata.greater_than("mortality_rate", 2) ## End(Not run)
Greater than equal condition by given column and value
altadata.greater_than_equal(condition_column, condition_value)
altadata.greater_than_equal(condition_column, condition_value)
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Nothing just set the greater than equal condition parameters
## Not run: altadata.greater_than_equal("mortality_rate", 3) ## End(Not run)
## Not run: altadata.greater_than_equal("mortality_rate", 3) ## End(Not run)
Less than condition by given column and value
altadata.less_than(condition_column, condition_value)
altadata.less_than(condition_column, condition_value)
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Nothing just set the less than condition parameters
## Not run: altadata.less_than("mortality_rate", 2) ## End(Not run)
## Not run: altadata.less_than("mortality_rate", 2) ## End(Not run)
Less than equal condition by given column and value
altadata.less_than_equal(condition_column, condition_value)
altadata.less_than_equal(condition_column, condition_value)
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Nothing just set the less than equal condition parameters
## Not run: altadata.less_than_equal("mortality_rate", 3) ## End(Not run)
## Not run: altadata.less_than_equal("mortality_rate", 3) ## End(Not run)
Get customer subscription info
altadata.list_subscription()
altadata.list_subscription()
dataframe object
## Not run: altadata.list_subscription() ## End(Not run)
## Not run: altadata.list_subscription() ## End(Not run)
Fetch data with configurations given before
altadata.load()
altadata.load()
dataframe object
## Not run: aldatata.api_key('YOUR_API_KEY') altadata.get_data("co_10_jhucs_03", limit = 50) altadata.load() ## End(Not run)
## 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
altadata.not_equal(condition_column, condition_value)
altadata.not_equal(condition_column, condition_value)
condition_column |
column to which the condition will be applied |
condition_value |
value to use with condition |
Nothing just set the not equal condition parameters
## Not run: altadata.not_equal("province_state", "Utah") ## End(Not run)
## Not run: altadata.not_equal("province_state", "Utah") ## End(Not run)
Select specific columns in the retrieve data process
altadata.select(selected_columns)
altadata.select(selected_columns)
selected_columns |
list of columns to select |
Nothing just set the select parameters
## Not run: altadata.select(c("reported_date", "province_state", "mortality_rate")) ## End(Not run)
## 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
altadata.sort(order_column, order_method = "asc")
altadata.sort(order_column, order_method = "asc")
order_column |
column to which the order is applied |
order_method |
sorting method. Posibble values: asc or desc |
Nothing just set the sort parameters
## Not run: altadata.sort("province_state", order_method = "desc") ## End(Not run)
## Not run: altadata.sort("province_state", order_method = "desc") ## End(Not run)