pepkit / pipestat

Pipeline results reporting package
https://pep.databio.org/pipestat/
BSD 2-Clause "Simplified" License
4 stars 2 forks source link

Pipestat messaging update suggestions #209

Open nsheff opened 3 hours ago

nsheff commented 3 hours ago

There's some confusing language I think we should clean up.

here's a vanilla looper check:

 looper check
Looper version: 2.0.0a2
Command: check
Using looper config (.looper.yaml).
No config key in Project, or reading project from dict
Traceback (most recent call last):
  File "/home/ns5bc/.local/bin/looper", line 8, in <module>
    sys.exit(main_cli())
             ^^^^^^^^^^
  File "/home/ns5bc/.local/lib/python3.11/site-packages/looper/cli_pydantic.py", line 357, in main_cli
    main()
  File "/home/ns5bc/.local/lib/python3.11/site-packages/looper/cli_pydantic.py", line 353, in main
    return run_looper(args, parser, test_args=test_args)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/ns5bc/.local/lib/python3.11/site-packages/looper/cli_pydantic.py", line 319, in run_looper
    raise PipestatConfigurationException("check")

Then I added this to the looper config:

pipestat:
  results_file_path: results.yaml

And now it says:

looper check
Looper version: 2.0.0a2
Command: check
Using looper config (.looper.yaml).
No config key in Project, or reading project from dict
Pipeline name mismatch detected. Pipeline interface: PEPATAC  Output schema: None  Defaulting to pipeline_interface value.
Initializing results file '/project/shefflab/brickyard/results_pipeline/tlgl_atac/PEPATAC/results.yaml'
File does not exist, but create_file is true. Creating...
     'PEPATAC' pipeline status summary     
┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃  Status   ┃    Jobs count/total jobs    ┃
┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
└───────────┴─────────────────────────────┘

Some things here confusing me:

nsheff commented 3 hours ago

I guess the biggest issue here is this: I cannot figure out how to configure pipestat such that looper check works, and there appears to be little documentation on that. it just says "use looper check", but that doesn't work.

Do you have to configure it before running the pipeline? I ran the pipeline before configuring pipestat. It still created flag files. now how do I check them?