Purpose: This documentation describes programmatic options for working with the Flywheel system underneath the NACC Data Platform.
These demos are meant to provide examples for people who are familiar with developing software and can adapt them to their working environment. If you are looking for solutions that run on the command-line, it is possible to use the Flywheel CLI tool for uploading and downloading data. There are some tasks (pulling participant identifiers and file upload errors) that cannot be done with the CLI, but are supported by the ADRC portals. Otherwise, the code here could be adapted someone familiar with Python or R to use in Jupyter notebooks or command line scripts.
The common directory of the demo repository contains a package of utilities used in the demo code.
Using these functions can help you avoid situations where data organization might be changed.
Distributions can be accessed via each release on GitHub.
It is helpful for most of these tutorials to understand how data is organized within the NACC Data Platform.
The NACC Data Platform is built on top of the Flywheel data management system. Flywheel organizes data by group and project, under which data for individual subjects is stored. Each center has a group, with a set of pipeline projects for each study to which it contributes.
You can see the group and projects you have access to within Flywheel, by opening the Projects page in the user interface, or by using the Flywheel CLI.
The list of projects you see will depend on your authorizations, but may include ingest-dicom, ingest-enrollment, and ingest-form.
These are the ingest pipeline projects, and are labeled by the datatype each is configured to handle.
You may also see an accepted project, which is where data that has passed QC can be accessed.
Each ingest- project has a corresponding sandbox- project for practice submissions.
You may also have projects that look like ingest-form-leads, or if your center was part of the UDSv4 Pilot a project like ingest-form-udsv4pilot.
These are pipelines that are dedicated to particular studies (other than the ADRC program) or purposes (such as the pilot).
The group and projects IDs and labels are used in uploading and accessing data within Flywheel.
For instance, the form ingest project in the NACC Sample Center, is referenced as sample-center/ingest-form.
The demo code includes utility functions that help build these references.
The function center_info.get_center_id() in the common package returns the group ID when given a center’s ADCID (the numeric ID used on form submissions), and pipeline.get_project() constructs the project label for a pipeline project.