We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent c909d4e commit 64abb05Copy full SHA for 64abb05
1 file changed
malariagen_data/anoph/sample_metadata.py
@@ -799,6 +799,17 @@ def clear_extra_metadata(self):
799
requested. The returned DataFrame is a copy and can be safely modified
800
without affecting internal caches.
801
""",
802
+ notes="""
803
+ Some samples in the dataset are lab crosses — mosquitoes bred in
804
+ the laboratory that have no real collection date. These samples
805
+ use ``year=-1`` and ``month=-1`` as sentinel values. They may
806
+ cause unexpected results in date-based analyses (e.g.,
807
+ ``pd.to_datetime`` will fail on negative year values).
808
+
809
+ To exclude lab cross samples, use::
810
811
+ df = api.sample_metadata(sample_query="year >= 0")
812
+ """,
813
)
814
def sample_metadata(
815
self,
0 commit comments