nimare.studyset.AnnotationSet

class AnnotationSet(id: str, name: str = '', columns: ColumnStore = None, note_key_types: dict = <factory>, metadata: dict = <factory>, description: str | None = None)[source]

Bases: object

One annotation: identity, declared types, and columns over the analyses.

NIMADS gives an annotation its own id, name and note_keys types, and a studyset may carry several. Keeping the set intact is what makes that representable – and prevents two annotations that share a label name from overwriting one another, which matters because compose’s default note key is included, so any two compose annotations on one studyset collide.

Methods

copy()

Return a shallow copy of the annotation.

dtype(label)

Return the type NIMADS declared for label, if any.

keys()

Return every label in the annotation.

Properties

columns

description

name

id

note_key_types

metadata

copy()[source]

Return a shallow copy of the annotation.

dtype(label)[source]

Return the type NIMADS declared for label, if any.

keys()[source]

Return every label in the annotation.

Examples using nimare.studyset.AnnotationSet

The NiMARE Studyset object

The NiMARE Studyset object