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.

Sign up for GitHub

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

Jump to bottom

Create README that provides a tutorial in how to run L2UniFrac #14

Open
1 of 4 tasks
dkoslicki opened this issue Jun 18, 2021 · 2 comments
Open
1 of 4 tasks

Create README that provides a tutorial in how to run L2UniFrac #14

dkoslicki opened this issue Jun 18, 2021 · 2 comments
Assignees
@andrew-j-millward
Labels
documentation Improvements or additions to documentation

Comments

@dkoslicki
Copy link
Member

dkoslicki commented Jun 18, 2021 •
edited
Loading

Include:

  • installation steps (will need a requirements.txt file)
  • example of computing all L2 pairwise UniFrac distances
  • example of computing means of a couple groups of samples
  • example of running DPCoA
@andrew-j-millward
Copy link
Collaborator

By requirements.txt, do you mean a requirements subsection on the README or an entirely separate document?

@andrew-j-millward andrew-j-millward added the documentation Improvements or additions to documentation label Jun 25, 2021
@andrew-j-millward
Copy link
Collaborator

Note: Make wrapper function to take in all inputs and run all scripts together. Output in usable format like biom and krona/taxonomy. Use optional parameters to select output generation files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andrew-j-millward andrew-j-millward

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dkoslicki @andrew-j-millward