chado.analysis package

Module contents

Contains possible interactions with the Chado Analysis Module

class chado.analysis.AnalysisClient(engine, metadata, session, ci)

Bases: chado.client.Client

Access to the chado analysis table

add_analysis(name, program, programversion, sourcename, algorithm=None, sourceversion=None, sourceuri=None, description=None, date_executed=None)

Create an analysis

Parameters:
  • name (str) – analysis name
  • program (str) – analysis program
  • programversion (str) – analysis programversion
  • algorithm (str) – analysis algorithm
  • sourcename (str) – analysis sourcename
  • sourceversion (str) – analysis sourceversion
  • sourceuri (str) – analysis sourceuri
  • description (str) – analysis description
  • date_executed (str) – analysis date_executed (yyyy-mm-dd)
Return type:

dict

Returns:

Analysis information

delete_analyses(analysis_id=None, name=None, program=None, programversion=None, algorithm=None, sourcename=None, sourceversion=None, sourceuri=None, description=None)

Delete analysis

Parameters:
  • analysis_id (int) – analysis_id filter
  • name (str) – analysis name filter
  • program (str) – analysis program filter
  • programversion (str) – analysis programversion filter
  • algorithm (str) – analysis algorithm filter
  • sourcename (str) – analysis sourcename filter
  • sourceversion (str) – analysis sourceversion filter
  • sourceuri (str) – analysis sourceuri filter
  • description (str) – analysis description
Return type:

None

Returns:

None

get_analyses(analysis_id=None, name=None, program=None, programversion=None, algorithm=None, sourcename=None, sourceversion=None, sourceuri=None, description=None)

Get all or some analyses

Parameters:
  • analysis_id (int) – analysis_id filter
  • name (str) – analysis name filter
  • program (str) – analysis program filter
  • programversion (str) – analysis programversion filter
  • algorithm (str) – analysis algorithm filter
  • sourcename (str) – analysis sourcename filter
  • sourceversion (str) – analysis sourceversion filter
  • sourceuri (str) – analysis sourceuri filter
  • description (str) – analysis description
Return type:

list of dict

Returns:

Analysis information