| Type: | Package |
| Title: | Request <https://openblender.io> API Services |
| Version: | 0.5.81 |
| Description: | Interface to make HTTP requests to 'OpenBlender' API services. Go to https://openblender.io for more information. |
| Depends: | R (≥ 3.3.3), httr (≥ 1.4.1), jsonlite (≥ 1.5) |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| LazyData: | true |
| RoxygenNote: | 7.0.2 |
| NeedsCompilation: | no |
| Packaged: | 2020-06-17 16:00:43 UTC; danie |
| Author: | Open Blender Inc. [cph], Daniel V. Pinacho [aut, cre] |
| Maintainer: | Daniel V. Pinacho <danielvpinacho@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2020-06-19 12:00:02 UTC |
Make HTTP request to openblender.io services
Description
Call 'OpenBlender' API services.
Usage
call(action, parameters)
Arguments
action |
Task you're requesting |
parameters |
Request options |
Value
A list that includes the new dataset id in case you create one, success/error message when you insert observations or the list of observations requested.
See Also
To see more details go to openblender.io
Examples
## Not run:
#CREATE DATASET
df <- read.csv(file = "/path/to/your/data.csv", header = TRUE, sep = ",")
action <- "API_createDataset"
parameters <- list(
token = "YOUR TOKEN",
id_user = "YOUR USER ID",
name = "Assign a name",
descriptipon = "Set a description",
visibility = "public",
tags = list("topic", "tag"),
insert_observations = "off",# set "on" if you want include the observations
dataframe = df
)
call(action, parameters)
#INSERT OBSERVATIONS
df <- read.csv(file = "/path/to/your/data.csv", header = TRUE, sep = ",")
action <- "API_insertObservations"
parameters <- list(
token = "YOUR TOKEN",
id_user = "YOUR USER ID",
id_dataset = "DATASET ID",
notification = "on",
observations = df
)
call(action, parameters)
#GET OBSERVATIONS
action <- "API_getObservationsFromDataset"
parameters <- list(
token = "YOUR TOKEN",
id_user = "YOUR USER ID",
id_dataset = "DATASET ID"
)
call(action, parameters)
## End(Not run)
Verify JSON
Description
Check if a dataframe can be transformed into JSON with no errors. This function is not accessible for users.
Usage
comprobarJSONaDF(df_json)
Arguments
df_json |
Dataframe to verify |
Value
Dataframe verified or an error message.
Request to the API, depending on the action provided
Description
Prepare the creation of a Dataset in 'OpenBlender' API. This function is not used by users.
Usage
create_dataset(json_parametros, url)
Arguments
json_parametros |
Request parameters that contains the dataset structure |
url |
Url selected |
Value
Dataset's id just created, using dameRespuestaLlamado.
HTTP request
Description
Make HTTP requests to 'OpenBlender' API services. This function is not used by users.
Usage
dameRespuestaLlamado(url, data)
Arguments
url |
URL selected |
data |
Request data |
Value
A list from 'OpenBlender' API (response).
Request to the API, depending on the action provided
Description
Prepare the data to send it 'OpenBlender' API. This function is not used by users.
Usage
genericDownloadCall(
json_parametros,
url,
action,
n_test_observations,
slice_mult
)
Arguments
json_parametros |
Request parameters |
url |
Url selected |
Value
List of observations obtained with dameRespuestaLlamado.
Request to the API, depending on the action provided
Description
Prepare the data to send it 'OpenBlender' API. This function is not used by users.
Usage
insert_observations(json_parametros, url)
Arguments
json_parametros |
Request parameters that contains the observations |
url |
Url selected |
Value
Data obtained with dameRespuestaLlamado. A success or error message.
Request to the API, depending on the action provided
Description
Prepare the data to send it 'OpenBlender' API. This function is not used by users.
Usage
power_model(json_parametros, url)
Arguments
json_parametros |
Request parameters |
url |
Url selected |
Value
A list obtained from dameRespuestaLlamado.