docs: expand documentation for sample_metadata()#933
docs: expand documentation for sample_metadata()#933Tanisha127 wants to merge 16 commits intomalariagen:masterfrom
Conversation
|
Hi @jonbrenas and @ahernank, I’ve opened PR #933 to expand the documentation for Thank you! |
|
Hi @jonbrenas , |
jonbrenas
left a comment
There was a problem hiding this comment.
The "summary" and "returns" are good, the "parameters" are read from base_params and are thus already described elsewhere, so they are not needed here.
|
Hi @jonbrenas, I've removed the parameters section as requested — only summary and returns remain. Could you please take another look when convenient? Thank you! |
|
Thanks @Tanisha127. When I run |
|
Thanks @jonbrenas! I chose those columns because they seemed like the most commonly used ones for a typical analysis — sample identity, collection metadata, QC, and species assignment. However, I can see that only listing 18 out of 58 columns could be misleading or incomplete for users who need the full picture. |
|
Hi @Tanisha127. I thinking grouping columns by category would be very convenient. |
|
Hi @jonbrenas, I've updated the returns section to group all columns by category. All checks are now passing. Could you please take another look when convenient? Thank you! |
|
Thanks @Tanisha127. Why did you choose to make 'Surveillance flags' its own category? Are there cases (I am thinking about the AIMs columns, for example) where it is possible to be more precise on whether a column will be present or not? |
|
Hi , Could you please take another look when convenient? Thank you! |
|
Thanks @Tanisha127, it is great! Is there a reason why 'quarter' is the only one with the details of what the value is when the data is missing? |
|
Hi @jonbrenas, I've removed the missing value detail from the quarter field to keep the documentation consistent with all other columns. I've also resolved the merge conflict with master. Could you please take another look when convenient? Thank you! |
This PR expands the documentation for
sample_metadata()to provide:Fixes #553.