Use tags in Flywheel to annotate your data, so you can then search on and filter data based on those tags. Creating tags is a 2-step process. First create your new tags at the group level. Next, you can add those tags to containers in Flywheel.
-
Use Flywheel to add tags to: Subjects and Sessions
-
Use the Flywheel SDK to add tags to: Projects, Subjects, Sessions, Acquisitions, Analyses, and Collections
All new tags are created at the group level. To create new tags:
-
Sign in to Flywheel.
-
Click Groups in the left navigation menu.
-
Select a group.
-
Click the Tags tab.
-
Enter a tag name, and click Add.
This tag is now available to add to any container– Project, Subject, Session, and Acquisition.Considerations
-
Tag names are not case sensitive. Meaning if the tag CONTROL already exists in a group, you cannot add a control tag.
-
You can use the same tag name across multiple groups in Flywheel. When you search, all data associated with that tag name appears.
-
Editing or deleting a tag name will change it throughout Flywheel.
- Site Admins can control who has permissions to create tags. Learn how to create a custom role in Flywheel or edit the permissions on existing roles.
-
In Flywheel you can add multiple tags to sessions and subjects. To do this:
-
Click Projects.
-
Select a project.
-
Select the Sessions tab.
All sessions for that project appear. -
Select a session.
-
In the left panel, click Sessions and go to Tags.
-
Start typing in a tag name. Available tag names appear in a list.
-
Add additional tags to this Session or Continue with other sessions that you want to tag.
-
Click Projects.
-
Select a project.
-
Select the Sessions tab.
-
(Optional) Click
to enable Subject View. -
Select the subject you want to tag.
-
In left panel click the Subject tab, and go to Tags.
-
Start typing a tag name. Available tag names appear in the list.
-
Add additional tags to this subject or continue with different subjects you want to tag.
If you want to view, add, or remove tags on Projects, Acquisitions, or Analyses you must use the Flywheel SDK. Tags on these containers do not appear in the Flywheel UI. The SDK is also the best method for bulk adding tags to groups so that users can then assign them in their projects as needed.
Below is an example of interacting with session tags. See the Flywheel SDK for more information.
# See tags on a session
session = fw.get(session_id)
print(', '.join(session.tags))
# Add a tag named Control to a session
session.add_tag('Control')
# Remove a tag from a session
session.delete_tag('Analysis Required')
FAQ
-
Do tags added via the SDK appear in the UI?
Tags added to the subject and session containers appear. Tags on Projects, Acquisitions, or Analyses require the SDK to view.
- Are tags inherited by other containers?
No. For example, if you tag a subject, the sessions associated with that subject do not also get that tag.
Basic Search: Enter the tag name in the search bar.
Advanced Search
- Navigate to Advanced Search
- Use the query builder or FlyQL and search on the following fields:
- group.tags
- project.tags
- subject.tags
- session.tags
- acquisition.tags