Skip to content

Commit 1da7fa5

Browse files
committed
edit doc strings for batch agg methods on workflow
1 parent eb6c229 commit 1da7fa5

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

panoptes_client/workflow.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -573,6 +573,9 @@ def run_aggregation(self, user=None, delete_if_exists=False):
573573
raise err
574574

575575
def get_batch_aggregation(self):
576+
"""
577+
This method will fetch existing aggregation resource, if any.
578+
"""
576579
try:
577580
return next(Aggregation.where(workflow_id=self.id))
578581
except StopIteration:
@@ -592,13 +595,17 @@ def _get_agg_property(self, param):
592595

593596
def check_batch_aggregation_run_status(self):
594597
"""
595-
This method will fetch existing aggregation status if any.
598+
This method will fetch existing aggregation status, if any.
596599
"""
597600
return self._get_agg_property('status')
598601

599602
def get_batch_aggregation_links(self):
600603
"""
601-
This method will fetch existing aggregation links if any.
604+
This method will fetch existing aggregation links, if any.
605+
606+
Data product options, returned as dictionary of type/URL key-value pairs:
607+
1. reductions: subject-level reductions results CSV
608+
2. aggregation: a ZIP file containing all inputs (workflow-level classification export, project-level workflows export) and outputs (extracts, reductions)
602609
"""
603610
uuid = self._get_agg_property('uuid')
604611
return {'reductions': 'https://aggregationdata.blob.core.windows.net/{}/{}_reductions.csv'.format(uuid, self.id),

0 commit comments

Comments
 (0)