search

malariagen / malariagen-data-python

Analyse MalariaGEN data from Python
https://malariagen.github.io/malariagen-data-python/latest/
MIT License
13 stars 23 forks source link

Consider adding more documentation for sample set metadata #553

Open leehart opened 3 months ago

leehart commented 3 months ago

Currently the documentation for the sample_metadata() function is very sparse in the API documentation, i.e.

A dataframe of sample metadata, one row per sample.

The sample metadata includes lots of fields that might benefit from better documentation, perhaps in the public user guides, e.g.

Note: we have various README.md docs in the GCS buckets alongside the data, e.g.