GitXplorerGitXplorer
s

okAPI

public
0 stars
12 forks
0 issues

Commits

List of commits on branch master.
Unverified
89ed22213b36af9275dfee55e61d218fe8678b73

removed link to SBG forum, since this yielded 404

ssatsumas committed 8 years ago
Unverified
51cd4c1f15e4b28b2742337bee702c0bc339c27a

Scientifically useful query

committed 8 years ago
Unverified
0c8ee5d70d49c1861f0126289ce51a3007a42ad4

Scientifically useful query

committed 8 years ago
Unverified
200c84838e251c26885dc85befb67832c74cc85b

Made minor changes to documentation of CCLE notebook

committed 8 years ago
Unverified
0ed02c9bab4be4a9c38031796280ba7d41165498

Added notebook for CCLE Datasets API

committed 8 years ago
Unverified
4beebab5c4c28eaa915f2c677f159ff5760ad46a

Adding new tutorial notebooks for sbpla as well

committed 8 years ago

README

The README file for this repository.

# ok, API

Official branch (master)

sevenbridges-python version Licence

To help people maximize the extensibility and automation capability of Seven Bridges products, we're happy to share example API code. ok, API contains examples have been used to address common user wants and needs. They are divided into recipes & tutorials.

  • "How do I do this one thing?" You want a recipe, which is a modular example of common operations.
  • "How do I complete my entire analysis?" You want a tutorial, which may combine multiple recipes to go from start to finish of an analysis.

The recipe and tutorial folders in this repository are subdivided into CGC (the Cancer Genomics Cloud) and SBPLAT (the Seven Bridges Platform). This separation ensures we link to the appropriate docs. Switching environments is as easy as changing

# [USER INPUT] specify platform {cgc, sbpla}
prof = 'cgc'

to

# [USER INPUT] specify platform {cgc, sbpla}
prof = 'sbpla'

in the second code cell of any recipe (Note some features are available on one platform but not the other). Each folder has it's own readme files within each folder which details the scripts. Feedback and improvements are welcome.

Background

This repository covers the Seven Bridges Plaform and the Cancer Genomics Cloud. To learn more, see their documentation.

Branches

Note there are two branches of this repository. You are on the master branch. We are currently populating this branch.

  • master: This was released April 2016 and uses sevenbridges-python, the official Seven Bridges Python bindings. This branch includes most of the API functionality and is compatible with Python 2.6+ and 3.
  • advanced_access: This was developed from January to May 2016 and uses apimethods.py. This is an unofficial branch where we may roll out new features. Currently there are more notebooks here. It is only compatible with Python 2.7.

Notes

  1. We ask that you limit parallel tasks to 200 at a time1. If you need to run more, that is great, but please get in touch with us so we don't run out of cloud.
  2. This is compatible with Python 2.6+ and Python 3.
  3. This is an beta and we are constantly working on improving our examples. Expect the awesomeness to continue.
  4. Please share your feedback on our CGC forum or by emailing support@sevenbridges.com.
  5. We are happy to recieve Pull Requests with your improvements or Issues which we will fix asap.

1 This limit is a rule of thumb for the CGC, it also depends on the complexity of the workflow and input files. For Seven Bridges Platform users, this limit depends on your contract.

Good luck, have fun!