search

hdr-bgnn / Morphology-analysis

Extract morphological characteristics from trait segmented fish
MIT License
1 stars 2 forks source link

review README #41

Closed meghalithic closed 1 year ago

meghalithic commented 1 year ago

issue #40

updated the readme based on discussions at the workflow meeting and comments on issue 40 and PR #36

meghalithic commented 1 year ago

@hlapp @johnbradley section 6 was more of notes for myself. It could probably be removed?

thibaulttabarin commented 1 year ago

LGTM, one thing though I would insist putting somewhere in the usage section this line : Morphology_main.py [-h] [--metadata METADATA] [--morphology MORPHOLOGY] [--landmark LANDMARK] [--lm_image LM_IMAGE] input_image output_presence

@hlapp @johnbradley What do you think?

meghalithic commented 1 year ago

@thibaulttabarin I broke it out into separate sections. Is it better to have it all together?

hlapp commented 1 year ago

putting somewhere in the usage section this line : Morphology_main.py [-h] [--metadata METADATA] [--morphology MORPHOLOGY] [--landmark LANDMARK] [--lm_image LM_IMAGE] input_image output_presence

I think that makes sense as a concise summary of the available options, perhaps best preceding (right before?) the documentation of each individual option.

meghalithic commented 1 year ago

@hlapp when I made edits it got rid of your comments...how do I see those?

hlapp commented 1 year ago

when I made edits it got rid of your comments...how do I see those?

Just click on the "Outdated" marker, and it should expand to the original comment or edit suggestion.

johnbradley commented 1 year ago

@hlapp @johnbradley section 6 was more of notes for myself. It could probably be removed?

@megbalk I updated section 6 to be more generic, but feel free to remove if you don't feel these instructions are necessary.

meghalithic commented 1 year ago

@hlapp how does @johnbradley change look?