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

Split README into separate documenation pages #54

Merged
merged 14 commits into from
Nov 26, 2024
Merged

Conversation

pgarrison
Copy link
Collaborator

@pgarrison pgarrison commented Nov 22, 2024

Issues addressed

  • README is dense and organization is unclear. We want to write to multiple audiences who want to use this for different purposes.
  • Docs include paths in tree diagrams that I didn't update when moving to the src/ and subpackages/ structure.
  • image_preprocessing usage instructions say --cores .. but .. is just a placeholder (Readme for preprocessing #39)
  • Preprocessing docs make dependence on two virtual environments more clear

Reviewing

See new version here

What do you all think about moving the reproducibility and dev documentation out of the main README and instead highlighting the "educational" example(s) @ritvikvasan proposed there?

@ritvikvasan
Copy link
Collaborator

Looks much better to me!

@pgarrison pgarrison marked this pull request as ready for review November 23, 2024 01:07
Copy link
Collaborator

@vianamp vianamp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this. As mentioned in Slack, replace the "movies" in the figure with single cell images.

Copy link
Collaborator

@ritvikvasan ritvikvasan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good mostly. I think for the workflow, we should split up the preprocessing steps between punctate and polymorphic models.

README.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants