tripal.feature package

Module contents

class tripal.feature.FeatureClient(tripalinstance, **requestArgs)

Bases: tripal.client.Client

Manage Tripal features

delete_orphans(job_name=None, no_wait=None)

Delete orphans Drupal feature nodes

Parameters:
  • job_name (str) – Name of the job
  • no_wait (bool) – Return immediately without waiting for job completion
Return type:

str

Returns:

status

get_features(feature_id=None)

Get features entities

Parameters:feature_id (int) – A feature entity/node ID
Return type:list of dict
Returns:Feature entity/node information
get_features_tripal(feature_id=None)

Get features entities

Parameters:feature_id (int) – A feature entity/node ID
Return type:list of dict
Returns:Feature entity/node information
sync(organism=None, organism_id=None, max_sync=u'', types=[], ids=[], job_name=None, no_wait=None)

Synchronize some features (Tripal 2 only)

Parameters:
  • organism (str) – Common name of the organism to sync
  • organism_id (str) – ID of the organism to sync
  • max_sync (str) – Maximum number of features to sync (default: all)
  • types (list of str) – List of types of records to be synced (e.g. gene mRNA, default: all)
  • ids (list of str) – List of names of records to be synced (e.g. gene0001, default: all)
  • job_name (str) – Name of the job
  • no_wait (bool) – Return immediately without waiting for job completion
Return type:

str

Returns:

status