Skip to content
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

Incorporate report generation into logging #414

Closed
tsalo opened this issue Nov 6, 2019 · 1 comment · Fixed by #424
Closed

Incorporate report generation into logging #414

tsalo opened this issue Nov 6, 2019 · 1 comment · Fixed by #424
Labels
documentation issues related to improving documentation for the project hackathon Issues to tackle in the NIH hackathon

Comments

@tsalo
Copy link
Member

tsalo commented Nov 6, 2019

Summary

We should be able to add custom levels to our logging configuration, which should also make it possible to compile our citable report and associated references without manually compiling the strings within the workflow.

Additional Detail

We need to add two new levels to our logging configuration: REPORT and REFERENCES. Each level should have its own formatter, as the report is a paragraph, while the references are a list. We can then load both files, reduce/sort the references, combine the two strings, and write out the full file at the very end of the tedana workflow.

Next Steps

  1. Add new levels to logging configuration.
    • INFO number is 20. Make REPORT=21, REFS=22, & INFO will be what is currently INFO (i.e. the full log)
  2. Design level-specific formatters.
    • Report should be stored as a paragraph.
    • References should be something that can be loaded as a list.
  3. Move report/references strings from tedana.workflows.tedana.py into the appropriate functions, with the methods LGR.report() and LGR.references().
@tsalo tsalo added documentation issues related to improving documentation for the project hackathon Issues to tackle in the NIH hackathon labels Nov 6, 2019
@tsalo
Copy link
Member Author

tsalo commented Nov 7, 2019

After digging into this further, it doesn't seem like it will be possible to add a new logging level and write out just that logging level to a specific file without severely misusing the logging library. If anyone has any ideas to get this working, please jump in on this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to improving documentation for the project hackathon Issues to tackle in the NIH hackathon
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant