mirror of
https://github.com/soconnor0919/hristudio.git
synced 2026-05-08 13:58:55 -04:00
5.2 KiB
5.2 KiB
Tutorial 2: Your First Study
Learn how to create a research study and configure team access.
Objectives
- Create a new research study
- Configure study settings (IRB, institution)
- Add team members with appropriate roles
What is a Study?
In HRIStudio, a Study is the top-level container for your research:
Study
├── Experiments (multiple protocols)
├── Participants (study participants)
├── Team Members (collaborators)
├── Forms & Surveys (consent, questionnaires)
└── Trials (individual experiment runs)
Step 1: Create a New Study
- Log in as Researcher or Administrator
- Click Studies in the sidebar
- Click Create Study
Study Settings
| Field | Description | Required |
|---|---|---|
| Name | Study title | Yes |
| Description | Brief overview of research goals | Yes |
| Institution | University or organization | No |
| IRB Protocol | Protocol number (e.g., 2024-HRI-001) | No |
| Status | Draft, Active, Completed, Archived | Yes |
Example: Creating "Robot Trust Study"
Name: Robot Trust Study
Description: Investigating how robot appearance affects human trust in collaborative tasks.
Institution: Bucknell University
IRB Protocol: 2024-HRI-TRUST
Status: Draft
Step 2: Add Team Members
Studies can have multiple collaborators with different roles:
| Role | Permissions |
|---|---|
| Owner | Full access, can delete study |
| Researcher | Create/edit experiments, manage participants |
| Wizard | Execute trials, control robot |
| Observer | View-only access, add annotations |
Adding a Wizard
- Open your study
- Go to Team tab
- Click Add Member
- Enter the wizard's email
- Select Wizard role
- Click Invite
The wizard will receive access to:
- View the study and experiments
- Execute trials
- Control the robot during trials
- Add notes to trials
Step 3: Install Robot Plugins
For studies involving robots, you need to install the appropriate plugin:
- Go to Plugins in the sidebar
- Select your study from the dropdown
- Click Browse Plugins
- Find your robot (e.g., "NAO6 Robot (ROS2 Integration)")
- Click Install
- Configure robot settings (IP address, etc.)
Plugin Configuration
For NAO6 robots:
Robot IP: 192.168.1.100
Connection Type: ROS2 Bridge
WebSocket URL: ws://localhost:9090
Step 4: Create Forms
Before running trials, you need consent forms:
- Go to Forms tab in your study
- Click Create Form
- Select form type:
- Consent - Informed consent documents
- Survey - Post-session questionnaires
- Questionnaire - Demographic forms
Form Templates
HRIStudio provides templates to get started:
| Template | Use Case |
|---|---|
| Informed Consent | Required for all participants |
| Post-Session Survey | Collect feedback after trials |
| Demographics | Collect participant information |
Step 5: Add Participants
- Go to Participants tab
- Click Add Participant
- Enter participant code (e.g., "P001")
- Fill in optional details
Batch Import
For large studies, import from CSV:
participantCode,name,email,notes
P001,John Smith,john@email.com,Condition A
P002,Jane Doe,jane@email.com,Condition B
Study Workflow
Draft → Active → Recruiting → In Progress → Completed
│ │ │ │ │
│ │ │ │ └── All trials done
│ │ │ └── Trials running
│ │ └── Recruiting participants
│ └── Ready to collect data
└── Setting up study
Study Settings Deep Dive
IRB Compliance
Store your IRB information:
- Protocol number
- Approval date
- Expiration date
- Consent form versions
Data Management
Configure data retention:
- Anonymization settings
- Export formats (CSV, JSON)
- Backup frequency
Notification Settings
Configure alerts for:
- Trial completion
- Participant issues
- Robot disconnection
Common Tasks
Clone a Study
Create a copy of an existing study:
- Open the study
- Click Settings (gear icon)
- Select Duplicate Study
- Enter new study name
Archive a Study
When a study is complete:
- Go to study settings
- Change status to Archived
- Data is preserved but study is read-only
Transfer Ownership
Change the study owner:
- Go to Team tab
- Find the new owner
- Click Make Owner
Troubleshooting
Can't Add Team Member
- Check email is correct
- User must have an HRIStudio account
- You must be an owner or admin
Plugin Installation Failed
- Check robot is on the network
- Verify WebSocket URL is correct
- Check Docker services are running
Next Steps
Now that your study is set up:
- Designing Experiments - Create your first experiment protocol
- Forms & Surveys - Customize your consent forms
- Running Trials - Learn about trial management
Previous: Getting Started | Next: Designing Experiments