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

Seurat output #25

Merged
merged 2 commits into from
Oct 28, 2022
Merged

Seurat output #25

merged 2 commits into from
Oct 28, 2022

Conversation

multimeric
Copy link
Collaborator

R/query.R Show resolved Hide resolved
@stemangiola stemangiola merged commit 1b9407f into master Oct 28, 2022
@stemangiola
Copy link
Owner

@multimeric for this (and other edits to the interface) could you please update README with example?

I'm doing this for scaled counts for example.

@multimeric
Copy link
Collaborator Author

multimeric commented Nov 7, 2022

Ultimately this sort of documentation and examples will need to be in the package documentation, not just the readme. Do you think we should actually just convert the Readme.md into package documentation, and then e.g. build a pkgdown website?

@stemangiola
Copy link
Owner

stemangiola commented Nov 7, 2022

Ultimately this sort of documentation and examples will need to be in the package documentation, not just the readme. Do you think we should actually just convert the Readme.md into package documentation, and then e.g. build a pkgdown website?

Correct and I like the spirit. Properly engineered documentation will be done eventually but is a lower priority at the moment. Minimal examples are now useful for our collaborators.

As a personal preference (that can change) I usually put verbose tutorials/examples in the README, not extremely formal documentation. For people can install and immediately test the code with copy and paste (I am aware that we need permission to execute the code in our case).

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.

create get_Seurat
2 participants