Generate TreeOfLife Documentation
@thompsonmj is already working on this.
Since Apr 22, 2025.
Assessment
This issue has not been assessed yet.
Description
We need proper documentation under a docs/ folder or potentially a MkDocs site since this is going to be quite large and complex. This will include:
- Purpose of these tools (generation of TreeOfLife-200M, etc.)
- How these tools fit into the processing (i.e., download with distributed-downloader, then the filtering, processing, etc.)
- This repo will contain multiple processing stages from simpler initial source dataset-specific (EOL, GBIF, BIOSCAN, FathomNet, LILA) to more use-case specific and overall dataset creation.
- Where include relation to TaxonoPy.
- This will be the Reproduce the dataset repo.
- How each tool works, their uses, etc.
- Dominant language
- Jupyter Notebook
- Stars
- 9
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Imageomics/TreeOfLife-toolbox
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 50/100
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 50/100
Imageomics/TreeOfLife-toolbox#26 · 1 comment ·
-
Add processing tools for exclusion sets (as methods)May be free again @vimar-gu claimed this 575 days ago, and no pull request is open. Openstructure
Imageomics/TreeOfLife-toolbox#22 · 2 comments · 4 assignees ·