Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ENH] add mrs and micr to folders and files pages #514

Merged
merged 2 commits into from
Sep 27, 2024
Merged

[ENH] add mrs and micr to folders and files pages #514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bdc3596
fix missing mrs and micr
Remi-Gau Sep 27, 2024
a5ffe37
change header
Remi-Gau Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 102 additions & 8 deletions docs/getting_started/folders_and_files/files.md
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably want to use a macro that renders this page automatically based on the schema rather that having this horror of HTML we have to manually update.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, please, otherwise we always would be out of date and (manual) duplication is evil -- error prone etc thus begging for removal of such a page altogether (after all -- this is just duplication of information from the spec, which also changes with EVERY version release).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah. This page comes from the old Starterkit which is jupyter book based and does not have the type of macros that mkdocs does so I had not bothered to automate that.
But given that I have a script to do it, turning it into a macro should be fairly easy.

Large diffs are not rendered by default.

9 changes: 8 additions & 1 deletion docs/getting_started/folders_and_files/folders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ Represents different types of data. Must be one of:
- `micr`: microscopy data
- `nirs`: near-infrared spectroscopy data
- `motion`: motion capture data
- `magnectic resonance spectroscopy`: motion capture data

The name for the datatype depends on the recording modality.

Expand All @@ -87,12 +88,13 @@ The name for the datatype depends on the recording modality.
.tg .tg-beh{border-color:#000000;color:var(--beh);font-size:18px; text-align:center;vertical-align:middle}
.tg .tg-nirs{border-color:#000000;color:var(--nirs);font-size:18px; text-align:center;vertical-align:middle}
.tg .tg-motion{border-color:#000000;color:var(--motion);font-size:18px; text-align:center;vertical-align:middle}
.tg .tg-mrs{border-color:#000000;color:var(--mrs);font-size:18px; text-align:center;vertical-align:middle}
</style>
<table class="tg">
<thead>
<tr>
<th class="tg-va6w"></th>
<th class="tg-xuqq" colspan="7"><span style="font-weight:bold"><b>modality</b></span></th>
<th class="tg-xuqq" colspan="8"><span style="font-weight:bold"><b>modality</b></span></th>
</tr>
</thead>
<tbody>
Expand All @@ -105,6 +107,7 @@ The name for the datatype depends on the recording modality.
<td class="tg-micr"><b>microscopy</b></td>
<td class="tg-nirs"><b>NIRS</b></td>
<td class="tg-motion"><b>motion</b></td>
<td class="tg-mrs"><b>MRS</b></td>
</tr>
<tr>
<td class="tg-mri">anat</td>
Expand All @@ -114,6 +117,7 @@ The name for the datatype depends on the recording modality.
<td class="tg-micr">micr</td>
<td class="tg-nirs">nirs</td>
<td class="tg-motion">motion</td>
<td class="tg-mrs">mrs</td>
</tr>
<tr>
<td class="tg-mri">func<br></td>
Expand All @@ -123,6 +127,7 @@ The name for the datatype depends on the recording modality.
<td class="tg-micr"></td>
<td class="tg-micr"></td>
<td class="tg-motion"></td>
<td class="tg-mrs"></td>
</tr>
<tr>
<td class="tg-mri">dwi</td>
Expand All @@ -132,6 +137,7 @@ The name for the datatype depends on the recording modality.
<td class="tg-micr"></td>
<td class="tg-micr"></td>
<td class="tg-motion"></td>
<td class="tg-mrs"></td>
</tr>
<tr>
<td class="tg-mri">perf</td>
Expand All @@ -141,6 +147,7 @@ The name for the datatype depends on the recording modality.
<td class="tg-micr"></td>
<td class="tg-micr"></td>
<td class="tg-motion"></td>
<td class="tg-mrs"></td>
</tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/stylesheets/extra.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
--beh: #fb9a99;
--nirs: #b2df8a;
--motion: #e31a1c;
--unused: #fdbf6f;
--mrs: #fdbf6f;
--unused2: #ff7f00;
--unused3: #cab2d6;
--unused4: #ffff99;
Expand Down
1 change: 1 addition & 0 deletions requirements.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
gender_guesser
geopy
markdown-it-py
mkdocs-material[imaging]
mkdocs-macros-plugin
mkdocs-open-in-new-tab
Expand Down
4 changes: 4 additions & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,16 @@ markdown==3.6
# mkdocs
# mkdocs-material
# pymdown-extensions
markdown-it-py==3.0.0
# via -r requirements.in
markupsafe==2.1.5
# via
# jinja2
# mkdocs
matplotlib==3.9.0
# via seaborn
mdurl==0.1.2
# via markdown-it-py
mergedeep==1.3.4
# via
# mkdocs
Expand Down
6 changes: 4 additions & 2 deletions tools/build/print_filename_templates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@
"eeg",
"ieeg",
"meg",
"pet",
"nirs",
"micr",
"motion",
"mrs",
"nirs",
"pet",
]


Expand Down