BodenmillerGroup / steinbock

A toolkit for processing multiplexed tissue images
https://bodenmillergroup.github.io/steinbock
MIT License
49 stars 14 forks source link

Improve DeepCell/Mesmer documentation #166

Closed jwindhager closed 1 year ago

jwindhager commented 1 year ago

Directly merging this into main, to update the live online documentation for the revisions

codecov-commenter commented 1 year ago

Codecov Report

Base: 30.65% // Head: 30.65% // No change to project coverage :thumbsup:

Coverage data is based on head (859f9be) compared to base (368fc9e). Patch has no changes to coverable lines.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #166 +/- ## ======================================= Coverage 30.65% 30.65% ======================================= Files 66 66 Lines 2512 2512 ======================================= Hits 770 770 Misses 1742 1742 ``` Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BodenmillerGroup). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BodenmillerGroup)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

nilseling commented 1 year ago

For the --preprocess/--postprocess options I would copy/paste the example you give into a text file, save it at preprocess.yaml and use it. Would this work or is there more formatting that I would need to do?

jwindhager commented 1 year ago

You mean for the manuscript? That should work (the example includes default values, so nothing should change).

nilseling commented 1 year ago

I mean for the way the docs are formatted

jwindhager commented 1 year ago

Sorry, me being silly: was this just a question, or do you want me to change something in the docs?

nilseling commented 1 year ago

No no, this was just a question. Or maybe to remind you that people might just copy/paste the

        threshold: true
        percentile: 99.9
        normalize: true
        kernel_size: 128

part into a file.

jwindhager commented 1 year ago

Great, thanks - copying this to a file is the intended way. Could you approve the PR, maybe? Cheers :-)