Create README that provides a tutorial in how to run L2UniFrac

KoslickiLab / L2-UniFrac

Expansion upon Median Unifrac to compute average phylogenetic distances between samples according to their UniFrac distance without producing negative abundance vectors.

1 stars 0 forks source link

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

Open dkoslicki opened 3 years ago

dkoslicki commented 3 years ago

Include:

[x] 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 commented 3 years ago

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

andrew-j-millward commented 3 years ago

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.