Skip to content

Comments

docs: expand documentation for sample_metadata()#933

Open
Tanisha127 wants to merge 1 commit intomalariagen:masterfrom
Tanisha127:improve-sample-metadata-docs
Open

docs: expand documentation for sample_metadata()#933
Tanisha127 wants to merge 1 commit intomalariagen:masterfrom
Tanisha127:improve-sample-metadata-docs

Conversation

@Tanisha127
Copy link

This PR expands the documentation for sample_metadata() to provide:

  • A clearer summary of how metadata is assembled
  • Detailed parameter descriptions
  • An expanded description of the returned DataFrame
  • Explanation of merged metadata sources (general metadata, QC metadata, surveillance flags, AIM, cohorts)

Fixes #553.

@Tanisha127
Copy link
Author

Hi @jonbrenas and @ahernank,

I’ve opened PR #933 to expand the documentation for sample_metadata().
I’d appreciate your feedback when you have time.
Also, the workflows are awaiting maintainer approval for CI to run.

Thank you!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consider adding more documentation for sample set metadata

1 participant