You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/how_to_use.rst
+23-1Lines changed: 23 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -169,4 +169,26 @@ You can loop through these motifs and perform your analysis.
169
169
-
170
170
-
171
171
MA0528.2
172
-
MA0609.2
172
+
MA0609.2
173
+
174
+
Here is a list of meta-info `fetch_motifs` method takes as an arugment to filter the motifs.
175
+
176
+
.. csv-table::
177
+
:header: "Argument", "Description"
178
+
:widths: 10, 80
179
+
180
+
"`matrix_id`","Takes precedence over all other selection criteria except 'all'. Only motifs with the given JASPAR matrix ID(s) are returned. A matrix ID may be specified as just a base ID or full JASPAR IDs including version number. If only a base ID is provided for specific motif(s), then just the latest version of those motif(s) are returned unless 'all_versions' is also specified."
181
+
"`collection`","Only motifs from the specified JASPAR collection(s) are returned. NOTE - if not specified, the collection defaults to CORE for all other selection criteria except 'all' and 'matrix_id'. To apply the other selection criteria across all JASPAR collections, explicitly set collection=None."
182
+
"`tf_name`","Only motifs with the given name(s) are returned."
183
+
"`tf_class`","Only motifs of the given TF class(es) are returned."
184
+
"`tf_family`","Only motifs from the given TF families are returned."
185
+
"`tax_group`","Only motifs belonging to the given taxonomic supergroups are returned (e.g. 'vertebrates', 'insects', 'nematodes' etc.)"
186
+
"`species`","Only motifs derived from the given species are returned. Species are specified as taxonomy IDs."
187
+
"`data_type`","Only motifs generated with the given data type (e.g. ('ChIP-seq', 'PBM', 'SELEX' etc.) are returned."
188
+
"`pazar_id`","Only motifs with the given PAZAR TF ID are returned."
189
+
"`medline`","Only motifs with the given medline (PubmMed IDs) are returned."
190
+
"`min_ic`","Only motifs whose profile matrices have at least this information content (specificty) are returned."
191
+
"`min_length`","Only motifs whose profiles are of at least this length are returned."
192
+
"`min_sites`","Only motifs compiled from at least these many binding sites are returned."
193
+
"`all_versions`","Unless specified, just the latest version of motifs determined by the other selection criteria are returned. Otherwise all versions of the selected motifs are returned."
194
+
"`all`","Takes precedent of all other selection criteria. Every motif is returned. If 'all_versions' is also specified, all versions of every motif are returned, otherwise just the latest version of every motif is returned."
0 commit comments