Tutorials

Three tutorials cover the full neuralfetch workflow — from discovering public datasets to fetching your first study and building your own.

1 · Fetch Your First Study
Browse the catalog, load a sample, and explore the events DataFrame.
import neuralset as ns

study = ns.Study(name="Grootswagers2022HumanSample",
                 path="./data")
study.download()
events = study.run()
print(events[["type","start","duration"]].head())
2 · Anatomy of a Study
Timelines, event types, subject metadata, and composing studies with transforms.
for tl in study.iter_timelines():
    print(tl)

events = study.run()
print(events["type"].value_counts())
3 · Create Your Own Study
Wrap any local or remote dataset as a Study subclass registered in the catalog.
class MyStudy(studies.Study):
    def iter_timelines(self):
        yield {"subject": "sub-01"}
    def _load_timeline_events(self, tl):
        return pd.DataFrame([...])

Fetch Your First Study

Fetch Your First Study

Anatomy of a Study

Anatomy of a Study

Creating Your Own Study

Creating Your Own Study

Gallery generated by Sphinx-Gallery