doc

hdmf-dev · Mar 3, 2024 · b32aeb1 · b32aeb1
1 parent 3b0a6d8
commit b32aeb1
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/gallery/plot_term_set.py b/docs/gallery/plot_term_set.py
@@ -129,6 +129,20 @@
     data=TermSetWrapper(value=['Homo sapiens'], termset=terms)
     )
 
+######################################################
+# Validate Compound Data with TermSetWrapper
+# ----------------------------------------------------
+# :py:class:`~hdmf.term_set.TermSetWrapper` can be wrapped around compound data.
+# The user will set the field within the compound data type that is to be validated
+# with the termset.
+c_data = np.array([('Homo sapiens', 24)], dtype=[('species', 'U50'), ('age', 'i4')])
+data = VectorData(
+    name='species',
+    description='...',
+    data=TermSetWrapper(value=c_data, termset=terms, field='species')
+    )
+
+
 ######################################################
 # Validate Attributes with TermSetWrapper
 # ----------------------------------------------------