-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Pipestat interface suggestions #158
Comments
Regarding clutter in return value: Lines 285 to 288 in 1fe44eb
|
Regarding
With the above example, However, if I attempt to specify the arguments, psm1 = PipestatManager(record_identifier="RECORD1", schema_path="sample_output_schema.yaml", results_file_path="results.yaml", pipeline_type="sample")
psm1.report(values={"number_of_things": 100})
result = psm1.retrieve_one(result_identifier="number_of_things") Error
|
Regarding
It appears that this was intentional: acf3a54 We wanted to return formatted results. For example, I know that PyPiper takes this returned formatted value and logs it. Is there an issue with it being a list? Should we just concatenate the formatted results into one big string? |
I think the return value of the report function should not be a list of strings. It should be some recognition about what was reported that is machine-understandable. There could be a separate function to take that programmatic output and produce a formatted string if that's what someone wants. generally you want a function to return something that can be used more universally, unless the whole point of the function is just to format a string. |
I've made associated issues for initial comment, so I will mark this specific issue as solved (close it) and work on the child issues. |
clutter in return value
It's distracting that every time I retrieve a value, I get all this other stuff (created time, modified time, record identifier):
I would expect it to just say:
why can't retrieve use the class record identifier?
I can do this:
It knows to put it on the record id I started with. But then why doesn't this work?
That's confusing to me
docs are wrong
following the tutorial, docs say this:
But I don't get
None
-- I get an exception:There are many other problems with the tutorial. Someone needs to actually go through it and run it. https://pep.databio.org/pipestat/code/python-tutorial/
Reporting result is returning a list
The text was updated successfully, but these errors were encountered: