Module: bbcflib.gdv

Python API for the GDV genome data viewer.

bbcflib.gdv.get_project(mail, key, project_key=None, project_id=None, serv_url='http://gdv.epfl.ch/pygdv')[source]

Retrieves properties of all projects own by a user, or a single project specified by key or id.

Parameters:
  • mail – user email.
  • key – user key.
  • project_key – (optional) project key.
  • project_id – (optional) project id.
  • serv_url – GDV’s url.
Return type:

JSON

bbcflib.gdv.multiple_tracks(mail, key, assembly_id=None, project_id=None, urls=, []names=, []extensions=, []force=False, serv_url='http://gdv.epfl.ch/pygdv')[source]

Upload multiple tracks to GDV.

Parameters:
  • urls – a list of urls.
  • extensions – a list of extensions, in the same order as the urls.
  • names – a list of track names, in the same order as the urls.

For other params: see single_track

bbcflib.gdv.new_project(mail, key, name, assembly_id, serv_url='http://gdv.epfl.ch/pygdv')[source]

Create a new project on GDV.

Parameters:
  • mail – user email.
  • key – user key.
  • name – project name.
  • assembly_id – Genrep numeric assembly identifier (must be BBCF_VALID).
Return type:

JSON

bbcflib.gdv.single_track(mail, key, assembly_id=None, project_id=None, url=None, name=None, extension=None, delete_target=False, delete_source=False, serv_url='http://gdv.epfl.ch/pygdv')[source]

Upload a new track on GDV to a specified project.

Parameters:
  • mail – user email.
  • key – user key.
  • assembly_id – Genrep numeric assembly identifier, optional if a project_id is specified.
  • project_id – the project identifier.
  • url – an url or path pointing to a file.
  • extension – file extension.
  • name – track name.
  • delete_target – force the file to be recomputed (boolean).
  • delete_source – if true and file is a local parth, the original file will be removed after job success.
Return type:

JSON

Previous topic

<no title>

Next topic

Subpackage: bbcflib.track

This Page

Websites