Learn R Programming

consibiocloudclient are used to fetch data from Consibio Cloud. You’ll need to have a Consibio Cloud account, in other to use this client.

Our R client interacts with the Consibio Cloud API, and provides tools to query data from resources like projects, elements, devices, and datalogs.

If you find any bugs or have any suggestions, please submit a request at our support portal.

Installing

consibiocloudclient is available on CRAN, and can be installed with:

install.packages("consibiocloudclient")

Getting started

To get started, you’ll need to authenticate with your Consibio Cloud account. This is done by calling the login function, which takes your username (email) as argument.

Once you execute the login function, a password prompt will appear, and you’ll be asked to enter your password.

library(consibiocloudclient)

login("bob@helloworld.com")

# After a successful login, a token will be stored in memory.
projects <- get_projects()

# If you want to log out, you can call the `logout` function.
logout()

# After logging out, it's necessary to restart your R-session in other to remove any token stored in memory.

For a more in-depth guide on how to get started, please see vignette("consibiocloudclient"). Open the vignette overview in your browser with browseVignettes("consibiocloudclient").

Copy Link

Version

Install

install.packages('consibiocloudclient')

Monthly Downloads

187

Version

1.0.0

License

MIT + file LICENSE

Maintainer

Tobias Nordahl

Last Published

July 30th, 2024

Functions in consibiocloudclient (1.0.0)

set_project_id

Set the Consibio project ID option
get_test

Consibio APIs status by calling the test endpoint
is_valid_entity_id

Is valid entity ID
get_projects

Get projects accessible to the user
is_valid_username

Check if a username is valid.
get_datalog

Get datalog for elements in project
get_users_me

Get the user information
get_device

Get device in project
logout

Logout by removing the username and cached token
login

Login to Consibio API
client_req_auth

Authenticate the request with the OAuth client
get_api_url

Get API URL from environment variable
get_elements

Get elements accessible to the user
get_project

Get project information
get_project_id

Get the Consibio project ID
get_devices

Get devices in project
get_element

Get element information
set_api_url

Set API URL in environment variable