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

Documentation update #24

Closed
kbestak opened this issue Nov 24, 2023 · 1 comment
Closed

Documentation update #24

kbestak opened this issue Nov 24, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kbestak
Copy link
Collaborator

kbestak commented Nov 24, 2023

I'll write issues found in the Documentation here for reference when they are fixed:

  • CITATIONS.md
  • README.md
    • workflow too small
    • update workflow with newer version
    • "image preprocessing" leftover? - add other headers also
    • output description missing
    • samplesheet.csv example has a space
  • USAGE.md
    • separartor
    • make sure example samplesheet exists
    • make sure params work
    • make it clearer conda is not supported
    • explain that running mixed samples possible, but that segmentation is applied as if comparable samples are used, e.g ilastik cannot handle different images as the project file defines if it is 1 or 2 channel.
  • OUTPUT.md
    • rewrite so that it reads better
    • MolkartQC - fix headers
    • combined qc metric file?

Can we remove run with conda tag on first page?

@kbestak kbestak self-assigned this Nov 28, 2023
@kbestak kbestak added the documentation Improvements or additions to documentation label Nov 28, 2023
@kbestak
Copy link
Collaborator Author

kbestak commented Dec 5, 2023

Addressed in: #33

@kbestak kbestak closed this as completed Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant