Skip to content

Commit d4323ae

Browse files
dnkennedydnkennedy
committed
updated some model documentation
1 parent aced5c2 commit d4323ae

File tree

2 files changed

+205
-0
lines changed

2 files changed

+205
-0
lines changed

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ Want other specific resources included, add them here (or file an issue)
3838
* Do any of the existing platforms already do this?
3939
* Which comes closest?
4040

41+
42+
# Our Training Resource Description Model
43+
44+
Our current model (v_0.0.1) is expressed in YAML [here](model/model.yaml). A more human-readable version of that model is [here](model/model.md).
45+
46+
4147
# Project development (OHBM Hackathon)
4248

4349
OHBM 2025 - [project-ohbm-hackathon here](https://github.com/ohbm/hackathon2025/issues/7)

‎model/model.md‎

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
# TrainingProductsSchema
2+
3+
**Description:** A schema for tagged training products
4+
5+
## Classes
6+
7+
### TrainingProduct
8+
9+
**Description:** A training product with various attributes
10+
11+
#### Attributes
12+
13+
- **ID**
14+
- **Description:** ID
15+
- **Range:** string
16+
17+
- **Tag_Team**
18+
- **Description:** Tag Team
19+
- **Range:** string
20+
21+
- **Course_Name**
22+
- **Description:** Course Name
23+
- **Range:** string
24+
25+
- **URL**
26+
- **Description:** URL
27+
- **Range:** string
28+
29+
- **Level**
30+
- **Description:** Level
31+
- **Range:** Level_enum
32+
- **Options:**
33+
- Beginner
34+
- Intermediate
35+
- Advanced
36+
- NA
37+
38+
- **Platform**
39+
- **Description:** Platform
40+
- **Range:** Platform_enum
41+
- **Options:**
42+
- Mac
43+
- Windows
44+
- Linux
45+
- Docker
46+
- Jupyter
47+
- NA
48+
49+
- **Keywords**
50+
- **Description:** Keywords
51+
- **Range:** string
52+
53+
- **Course_Length**
54+
- **Description:** Course Length
55+
- **Range:** Course_Length_enum
56+
- **Options:**
57+
- <1 hr
58+
- 1-4 hrs
59+
- 1 day
60+
- 1-3 days
61+
- 1 week
62+
- 1+ weeks
63+
- NA
64+
65+
- **Instruction_Medium**
66+
- **Description:** Instruction Medium
67+
- **Range:** Content_format_enum
68+
- **Options:**
69+
- Hands-on tutorial / notebooks
70+
- lecture
71+
- video
72+
- notes
73+
- blog post
74+
- reference
75+
- slides
76+
- website
77+
- outline
78+
- meta-resource
79+
- Hybrid
80+
- NA
81+
82+
- **Delivery**
83+
- **Description:** Delivery
84+
- **Range:** Delivery_enum
85+
- **Options:**
86+
- self-paced
87+
- instructor
88+
- Discussion needed
89+
- NA
90+
91+
- **Language**
92+
- **Description:** Language
93+
- **Range:** Language_enum
94+
- **Options:**
95+
- English
96+
- French
97+
- Spanish
98+
- Chinese
99+
- Other
100+
- German
101+
- NA
102+
103+
- **Programming_Language**
104+
- **Description:** Programming Language
105+
- **Range:** Programming_language_enum
106+
- **Options:**
107+
- Python
108+
- R
109+
- shell scripting
110+
- Matlab
111+
- Git
112+
- NA
113+
114+
- **Neuroimaging_Software**
115+
- **Description:** Neuroimaging Software
116+
- **Range:** Neuroimaging_Software_enum
117+
- **Options:**
118+
- AFNI
119+
- SPM
120+
- FSL
121+
- Freesurfer
122+
- NA
123+
124+
- **Imaging_Modality**
125+
- **Description:** Imaging Modality
126+
- **Range:** Imaging_Modality_enum
127+
- **Options:**
128+
- DWI
129+
- Structural
130+
- Functional
131+
- Task-based
132+
- Resting-State
133+
- EEG
134+
- Behavioral
135+
- MEG
136+
- MRI
137+
- NA
138+
139+
- **Open_Dataset**
140+
- **Description:** Open Dataset
141+
- **Range:** Open_dataset_enum
142+
- **Options:**
143+
- Yes
144+
- No
145+
- NA
146+
147+
- **Last_Updated**
148+
- **Description:** Last Updated
149+
- **Range:** string
150+
151+
- **Functionality**
152+
- **Description:** Functionality
153+
- **Range:** string
154+
155+
- **Assessment**
156+
- **Description:** Assessment
157+
- **Range:** Assessment_enum
158+
- **Options:**
159+
- Yes
160+
- No
161+
- NA
162+
163+
- **Prerequisite**
164+
- **Description:** Prerequisite
165+
- **Range:** string
166+
167+
- **Source**
168+
- **Description:** Source
169+
- **Range:** string
170+
171+
- **Review**
172+
- **Description:** Review
173+
- **Range:** string
174+
175+
- **Exclude_from_ReproInventory**
176+
- **Description:** Exclude from ReproInventory
177+
- **Range:** Exclude_from_ReproInventory_enum
178+
- **Options:**
179+
- Yes
180+
- No
181+
- NA
182+
183+
- **Alias_Links**
184+
- **Description:** Alias Links
185+
- **Range:** string
186+
187+
- **Notes**
188+
- **Description:** Notes
189+
- **Range:** string
190+
191+
- **Quadrants**
192+
- **Description:** Quadrants
193+
- **Range:** Quadrants_enum
194+
- **Options:**
195+
- information-oriented (reference)
196+
- understanding-oriented (explanation)
197+
- learning-oriented (tutorials)
198+
- problem-oriented (how to guides)
199+
- NA

0 commit comments

Comments
 (0)