README.md

In rafalszota/RCooladata: Connection to Cooladata API from R environment

Why use RCooladata

The motivation of RCooladata is simple: employ powerfull statistical analysis to the user behaviour data stored in Cooladata. The package allows you to natively query Cooladata (CQL) and store the results in the data frame for further analysis.

Usage

The package expose single function: cooladataConnection(projectID). The function takes numeric argument: Cooldata Project ID. You can find your id in your Cooladata environment under: Project/Settings/ProjectID. Use the function to setup connection with Cooladata in order to execute the queries.

projectID <- 123456
cooladata <- cooladataConnection(projectID)

Once the connection is established as cooladata object in R, use this object to execute arbitrary query by passing CQL string as an argument. The result is parsed to R data frame.

query <- "SELECT event_name, event_time_ts FROM cooladata WHERE date_range(last 7 days) limit 10"
result <- cooladata(query)

Install

The easiest way to install the package is using direct installation from GitHub using devtools. You can obtain devtools directly from CRAN by executing install.packages("devtools").

Use install_github function to download and setup the package in your environment.

library(devtools)
devtools::install_github("rafalszota/RCooladata")
library(RCooladata)

Alternatively, clone the GitHub repository and install the package manually by executing devtools::install.

Using RCooladata requires httr dependency. In the case you don't have this package installed yet, you can obtain it from CRAN by executing install.packages("httr").

Before creating cooladata connection you need to store Cooladata Developer Token in your local file. Create a file named .cooladatatoken under your home folder (/Users/<username> for Linux and Mac, c:\Users\<username> for Windows). The file should be plain text with a single line containing the token. Make sure not to include whitespaces nor line breaks in the end of the file.

You can find your developer in Cooladata environment under <Profile>/API Token.

Getting help

Use standard R help for the package. Exectue ?? RCooladata or ??cooladataConnection to access help pages. CQL language reference can be found in Cooladata documentation: http://docs.cooladata.com/cql-coolasql

License

This package is distributed under Creative Commons Attribution (CC BY 3.0) license terms and conditions. Find the full legal text of the license here: https://creativecommons.org/licenses/by/3.0/legalcode

You are free to: Share - copy and redistribute the material in any medium or format, Adapt - remix, transform, and build upon the material, for any purpose, even commercially.

You are obliged to respect the following terms: Attribution - give an appropriate credit, by providing a link to my LinkedIn (https://www.linkedin.com/in/rafalszota) or GitHub (https://github.com/rafalszota) account. You may do so in any reasonable manner, but not in any way that suggests the I'm endorsing you or your use. No additional restrictions - You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.

rafalszota/RCooladata documentation built on May 26, 2019, 9:51 p.m.