From d56867c78c102a3cf76e0521a294401048fa1718 Mon Sep 17 00:00:00 2001
From: Oliver Diers <oliver.diers@edu.ruhr-uni-bochum.de>
Date: Wed, 19 Feb 2025 11:55:24 +0100
Subject: [PATCH] Updated readme: - Updated tutorial image - Updated tutorial -
Added Import from Excel section
---
README.md | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index c85f8c9..41ff278 100644
--- a/README.md
+++ b/README.md
@@ -36,9 +36,22 @@ Input fields top down:
If the selection of modality folders is not sufficient, the user can add (**additional!**) custom modality folders, once this option is selected.
1. _Modality Folder:_
Comma-separated list of custom modality folder names.
-8. _Create:_
+8. _Import from Excel:_
+ More in the [Import from Excel](#import-from-excel) section.
+9. _Create:_
Starts the process of folder creation. Once finished, the user will be informed via a pop-up message.
+## Import from Excel
+Instead of filling out every field manually, most of the values can be imported from an _.xlsx_ Excel document.
+Use the example Excel document provided [here](/additional documents/xlsxBase.xlsx) as a base for creating/filling out your own. There are some requirements for an Excel document to be properly imported:
+- The order of the columns must not be changed
+- Session IDs under 10 need a leading zero (i.e. "Session Date 01" and so on)
+- Valid values for the Subject Sex column only include: m[ale], f[emale], m[ännlich], w[eiblich], u[ndefined]
+- Valid values for the Subject Type column only include: Healthy test subject, Patient, Healthy control subject
+- Removing/Adding session date columns is allowed, as long as they follow the same naming scheme
+
+Additionally, one _meta.json_ file has to be provided, which will serve as the base for creating the study. This file will be used as the base for all subsequently created _meta.json_ files.
+
## License and Citation
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License: https://creativecommons.org/licenses/by-sa/4.0/
--
GitLab