Skip to content

Commit cbc014e

Browse files
committed
Document the label_threshold parameter in get_studies_by_label
1 parent ba8d921 commit cbc014e

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

nimare/dataset.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -668,7 +668,12 @@ def get_studies_by_label(self, labels=None, label_threshold=0.001):
668668
the labels above the threshold, it will be returned.
669669
Default is None.
670670
label_threshold : :obj:`float`, optional
671-
Default is 0.5.
671+
Minimum value a study must reach for *every* requested label to be included.
672+
For Neurosynth-style annotations these are tf-idf (term frequency-inverse
673+
document frequency) weights: a higher value means the label/term is more
674+
important to that study's text relative to the rest of the corpus. Because
675+
tf-idf is corpus-relative, the threshold is only meaningful within the corpus
676+
the annotations were derived from. Default is 0.001.
672677
673678
Returns
674679
-------

0 commit comments

Comments
 (0)