diff --git a/README.md b/README.md index c85f8c9845ded5f73bd8a4970f189cb9daa962a8..41ff278b811a78c1373678c8b31f589be1406c5a 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/ diff --git a/additional documents/.gitkeep b/additional documents/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/additional documents/xlsxBase.xlsx b/additional documents/xlsxBase.xlsx new file mode 100644 index 0000000000000000000000000000000000000000..68db0c57afa985138418ce8df31fb55ef0b8c793 Binary files /dev/null and b/additional documents/xlsxBase.xlsx differ diff --git a/images/StudyCreator_tutorial.png b/images/StudyCreator_tutorial.png index 6e43f90ac9a33b53d618b2ab2221a2c20747e942..0732f889cab6415c12bf18f38c546c3c8318b374 100644 Binary files a/images/StudyCreator_tutorial.png and b/images/StudyCreator_tutorial.png differ