biocore/empress

Document Empress' existing python API

Aperta

#426 aperta il 16 ott 2020

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (32 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (56 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

It's currently possible to use Empress through Python, even outside of QIIME 2 (so long as all needed dependencies are installed). This is already done in the make-dev-page.py test script. However, this isn't really advertised anywhere.

It'd be nice to add a Jupyter Notebook (similar to what Emperor has in its repository) that documents this API. Linking such a notebook from the README would, in tandem with #425, probably help expand the tool's user base a decent amount.

Guida contributor

Direzione di ricerca
Esamina l'API Python esistente in Empress, in particolare lo script `make dev page.py`, e crea un Jupyter notebook che dimostri come usare Empress tramite Python. Quindi aggiorna il README per collegare il notebook.
Tech stack
python
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonJupyter Notebook
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70