App Chains (Real-Time Personalization)

App Chains are the easy way to code Real Time Personalization (RTP) into your app.

App chains allows you to personalize your app and provide a genetically tailored user experience.

• Your app can now understand and treat each app user as the unique individual they are.

App chains are designed by coders, for coders.

• They are easy to use and quick to implement.

You don't have to know anything about the genetics or the genetic code.

• To use app chains and add RTP to your app, all you need to know is the software code you use everyday.

The searchable list of all App Chains, along with additional info and code snippets for each chain, can be accessed here -> https://sequencing.com/app-chains/

While there are already app chains to personalize most apps, if you need something but don't see an app chain for it, tell us! (ie email us: gittaca@sequencing.com).

This repo contains code for App Chains in the following languages:

• Swift
• Objective-C
• Java - Android
• Java
• PHP
• Perl
• Python
• C#/.NET

Plugins for implementing Sequencing.com's Real-Time Personalization (+RTP) API:

• CocoPod (iOS Swift)
• CocoPod (iOS Objective-C)
• Maven (Android Java)
• Nuget (Windows C#/.NET)

App chains are free for development use. Register for a free Sequencing.com account

Contents

• Introduction
• Example (of an app using RTP)
• Installation
• Configuration
• Troubleshooting
• Maintainers
• Contribute

Introduction

An app chain is an integration of an API call and an analysis of an app user's genes. Each app chain provides information about a specific trait, condition, disease, supplement or medication. App chains are used to provide genetically tailored content to app users so that the user experience is instantly personalized at the genetic level. This is called Real Time Personalization (RTP).

Each app chain consists of:

1. API call

• API call that triggers an app hosted by Sequencing.com to perform genetic analysis on your app user's genes

2. API response

• the straightforward, easy-to-use results are sent to your app as the API response

3. Personalzation

• your app uses this information, which is obtained directly from your app user's genes in real-time, to create a truly personalized user experience

To code Real Time Personalization (RTP) technology into apps, developers may register for a free account at Sequencing.com. App development with RTP is always free.

Example

What types of apps can you personalize with app chains? Any type of app... even a weather app.

• The open source Weather My Way +RTP app differentiates itself from all other weather apps because it uses app chains to provide genetically tailored content in real-time to each app user.
• Experience it yourself using one of the fun sample genetic data files. These sample files are provided for free to all apps that use app chains.

Installation

The code for each App Chain is provided in various coding languages. App developers can cut and paste the code into their apps so that their apps can utilize RTP technology straight out-of-the-box.

Configuration

There are no strict configurations that have to be performed.

Just drop the source files for an app chain into your project to add Real-Time Personalization to your app.

Code snippets below contain the following three placeholders. Please make sure to replace each of the placeholders with real values:

• <your token>

• replace with the oAuth2 secret obtained from your Sequencing.com account

• The code snippet for enabling Sequencing.com's oAuth2 authentication for your app can be found in the oAuth2 code and demo repo

• <chain id>

• replace with the App Chain ID obtained from the list of App Chains

• <file id>

• replace with the file ID selected by the user while using your app

• The code snippet for enabling Sequencing.com's File Selector for your app can be found in the File Selector code repo

Java

AppChains Java API overview

Method	Purpose	Arguments	Description
public AppChains(String token, String chainsHostname)	Constructor	token - security token provided by sequencing.com chainsHostname - API server hostname. api.sequencing.com by default	Constructor used for creating AppChains class instance in case reporting API is needed and where security token is required
public Report getReport(String remoteMethodName, String applicationMethodName, String datasourceId)	Reporting API	remoteMethodName - REST endpoint name, use "StartApp" applicationMethodName - name of data processing routine datasourceId - input data identifier
public Map<String, Report> getReportBatch(String remoteMethodName, Map<String, String> appChainsParams)	Reporting API	remoteMethodName - REST endpoint name, use "StartApp" applicationMethodName - name of data processing routine appChainsParams - map of chain and file identifiers

Prerequisites:

• Add Google GSON into your classpath

Adding code to the project:

• Add AppChains.java into your source folder and import (import com.sequencing.appchains.AppChains.*) it in your class file.

After that you can start utilizing Reporting API

AppChains chains = new AppChains("<your token>", "api.sequencing.com");

// retrieving single chain result
Report result = chains.getReport(
		"StartApp",
		"Chain8", // chain identifier
		"227680"  // file identifier
		);

if (result.isSucceeded() == false)
	System.out.println("Request has failed");
else
	System.out.println("Request has succeeded");

printReport(result);

// retrieving multiple chain results
Map<String, String> appChainsParams = new HashMap<String, String>();
appChainsParams.put("Chain9",  "227680");
appChainsParams.put("Chain88", "227680");

Map<String, Report> reportMap = chains.getReportBatch("StartAppBatch", appChainsParams);
printReport(reportMap.get("Chain9"));
printReport(reportMap.get("Chain88"));

See "printReport" reference here

Objective-C

For Objective-C code, reference and integration instructions please check details here

Swift

For Objective-C code, reference and integration instructions please check details here

C#

AppChains C# API overview

Method	Purpose	Arguments	Description
public AppChains(string token, string chainsUrl, string beaconsUrl)	Constructor	token - security token provided by sequencing.com chainsUrl - API server hostname. api.sequencing.com by default beaconsUrl - beacons API server hostname. https://beacon.sequencing.com by default	Constructor used for creating AppChains class instance in case reporting API is needed and where security token is required
public Report GetReport(string applicationMethodName, string datasourceId)	Reporting API	applicationMethodName - name of data processing routine datasourceId - input data identifier
public Report GetReportBatch(Dictionary<string, string> appChainsParams)	Reporting API	appChainsParams - map of chain and file identifiers
public Dictionary<string, Report> GetReportBatch(Dictionary<string, string> appChainsParams)	Reporting API	Dictionary<string, string> appChainsParams - app chains request parameters

Prerequisites:

• Add Newtonsoft.Json and RestSharp nuget packages into your project

Adding code to the project:

• Add SQAPI folder with all files into your project

After that you can start utilizing Reporting API:

var chains = new AppChains("<your token>", "https://api.sequencing.com/v1", "https://beacon.sequencing.com/");

Report result = chains.GetReport("Chain9", "FILE:80599");
if (result.Succeeded == false)
    Console.WriteLine("Request has failed");
else
    Console.WriteLine("Request has succeeded");
foreach (Result r in result.getResults())
{
    ResultType type = r.getValue().getType();

    if (type == ResultType.TEXT)
    {
        var v = (TextResultValue) r.getValue();
        Console.WriteLine(" -> text result type {0} = {1}", r.getName(), v.Data);
    }

    if (type == ResultType.FILE)
    {
        var v = (FileResultValue) r.getValue();
        Console.WriteLine(" -> file result type {0} = {1}", r.getName(), v.Url);
        v.saveTo("<your token>", ".\\");
    }
}

// retrieving multiple chain results
var appChainsParms = new Dictionary<string, string>();
appChainsParms["Chain9"] = "227680";
appChainsParms["Chain88"] = "227680";

var jobReports = chains.GetReportBatch(appChainsParms);
PrintReport("<your token goes here>", jobReports["Chain9"]);
PrintReport("<your token goes here>", jobReports["Chain88"]);

PHP

AppChains PHP API overview

Method	Purpose	Arguments	Description
public function __construct($token = null, $chainsHostname = null)	Constructor	token (optional) - security token provided by sequencing.com chainsHostname (optional) - API server hostname. api.sequencing.com by default	Use both arguments for creating chains instance in case reporting API is required
public function getReport($remoteMethodName, $applicationMethodName, $datasourceId)	Reporting API	remoteMethodName - REST endpoint name, use "StartApp" applicationMethodName - name of data processing routine datasourceId - input data identifier

Prerequisites:

• PHP 5.x and higher

Adding code to the project:

• Add AppChains.php into your source folder and import (require_once("AppChains.php");) it in your PHP file.

After that you can start utilizing Reporting API

$chains = new AppChains("<your token>", "api.sequencing.com");
$chainsResult = $chains->getReport("StartApp", "<chain id>", "<file id>");
	
if ($chainsResult->isSucceeded())
	echo "Request has succeeded\n";
else
	echo "Request has failed\n";
	
foreach ($chainsResult->getResults() as $r)
{
	$type = $r->getValue()->getType();
		
	switch ($type)
	{
		case ResultType::TEXT:
			$v = $r->getValue();
			echo sprintf("-> text result type %s = %s\n", $r->getName(), $v->getData());
		break;
		case ResultType::FILE:
			$v = $r->getValue();
			echo sprintf(" -> file result type %s = %s\n", $r->getName(), $v->getUrl());
			$v->saveTo("d:\data");
		break;
	}
}

Python

AppChains Python API overview

Method	Purpose	Arguments	Description
def __init__(self, token=None, hostname=None)	Constructor	token (optional) - security token provided by sequencing.com hostname (optional) - API server hostname. api.sequencing.com by default	Use both arguments for creating chains instance in case reporting API is required
def getReport(self, remote_method_name, app_method_name, source_id)	Reporting API	remote_method_name - REST endpoint name, use "StartApp" app_method_name - name of data processing routine source_id - input data identifier

Prerequisites:

• Python 2.7.x

Adding code to the project:

• Add AppChains.py into your source folder and import AppChains (from AppChains import AppChains) in your Python file.

After that you can start utilizing Reporting API

self.chains = AppChains('<your token>', 'api.sequencing.com')
chains_result = self.chains.getReport('StartApp', '<chain id>', '<file id>')
if chains_result.isSucceeded():
    print('Request has succeeded')
    else:
        print('Request has failed')
        for r in chains_result.getResults():
            file_type = r.getValue().getType()
            v = r.getValue()
            if file_type == 'TEXT':
                print('-> text result type {} = {}'.format(
                    r.getName(), v.getData()))
            elif file_type == 'FILE':
                print(' -> file result type {} = {}'.format(
                    r.getName(), v.getUrl()
                ))
                v.saveTo('/tmp')

Perl

AppChains Perl API overview

Method	Purpose	Arguments	Description
sub new	Constructor	1st arg (optional) - security token provided by sequencing.com 2nd arg (optional) - API server hostname. api.sequencing.com by default	Use both arguments for creating chains instance in case reporting API is required
sub getReport	Reporting API	1st arg - REST endpoint name, use "StartApp" 2nd arg - name of data processing routine 3rd arg - input data identifier

Prerequisites:

• Perl 5.10.x

Adding code to the project:

• Add AppChains.pm into your source folder and import AppChains in your Perl file (use AppChains;).

Adding code to the project:

• Add AppChains.h, AppChains.m into your source folder and import AppChains in your Objective-C source file (#import "AppChains.h").

After that you can start utilizing Reporting API

my $chains = AppChains->new("<your token>", "api.sequencing.com");
my $chainsResult = $chains->getReport("StartApp", "<chain id>", "<file id>");

if ($chainsResult->isSucceeded()) {
	print "Request has succeeded\n";
} else {
	print "Request has failed\n";
}

foreach (@{$chainsResult->getResults()})
{
	my $type = $_->getValue()->getType();
	
	if ($type == ResultType->TEXT)
	{
		my $v = $_->getValue();
		print sprintf("-> text result type %s = %s\n", $_->getName(), $v->getData());
	}
	elsif ($type == ResultType->FILE)
	{
		my $v = $_->getValue();
		print sprintf(" -> file result type %s = %s\n", $_->getName(), $v->getUrl());
		$v->saveTo("/tmp");
	}
}

Troubleshooting

Each app chain code should work straight out-of-the-box without any configuration requirements or issues.

Other tips

• Ensure that the following three placeholders have been substituted with real values:

1. <your token>

• replace with the oAuth2 secret obtained from your Sequencing.com account
• The code snippet for enabling Sequencing.com's oAuth2 authentication for your app can be found in the oAuth2 code and demo repo

2. <chain id>

• replace with the App Chain ID obtained from the list of App Chains

3. <file id>

• replace with the file ID selected by the user while using your app.

• The code snippet for enabling Sequencing.com's File Selector for your app can be found in the File Selector code repo

• Developer Documentation

• oAuth2 guide

• Review the Weather My Way +RTP app, which is an open-source weather app that uses Real-Time Personalization to provide genetically tailored content

• Confirm you have the latest version of the code from this repository.

Maintainers

The codebase is actively maintained by Sequencing.com. Please email the Sequencing.com bioinformatics team at gittaca@sequencing.com if you require any more information or just to say hola.

Contribute

We encourage you to passionately fork us. If interested in updating the master branch, please send us a pull request. If the changes contribute positively, we'll let it ride.