EdinburghGenomics / pyclarity-lims

Python interface to the GenoLogics LIMS server via its REST API.
MIT License
11 stars 5 forks source link

result_files()[source]¶ documentation incorrect #38

Closed EGCGDanForth closed 6 years ago

EGCGDanForth commented 6 years ago

For class pyclarity_lims.entities.Process for ""result_files()[source]"

The documentation states: "Retrieve all resultfiles of output-generation-type perInput."

However, it doesn't seem to do this and instead seems to retrieve all artifacts of output_type "ResultFile:

def result_files(self): """Retrieve all resultfiles of output-generation-type perInput.""" artifacts = self.all_outputs(unique=True) return [a for a in artifacts if a.output_type == 'ResultFile']

EGCGDanForth commented 6 years ago

I should probably add that having "result_files(self)" retrieve all artifacts with output_type "ResultFile" is not as useful as retrieving by "output-generation-type" "per input" as there are other ways to get them by "ResultFile".