update dataset_description.py with study details

code/bids_conversion/highspeed-bids-description.py

@@ -3,7 +3,7 @@
 # ======================================================================
 # SCRIPT: UPDATE OF BIDS DIRECTORY
 # PROJECT: HIGHSPEED
-# WRITTEN BY LENNART WITTKUHN, 2018 - 2019
+# WRITTEN BY LENNART WITTKUHN, 2018 - 2020
 # CONTACT: WITTKUHN AT MPIB HYPHEN BERLIN DOT MPG DOT DE
 # MAX PLANCK RESEARCH GROUP NEUROCODE
 # MAX PLANCK INSTITUTE FOR HUMAN DEVELOPMENT
@@ -17,11 +17,10 @@ import os
 # ======================================================================
 # DEFINE PATHS
 # ======================================================================
-# path to the root directory:
-path_root = os.environ['HOME']
-# path to the data input directory (in bids format):
-path_bids = os.path.join(path_root, 'highspeed', 'bids')
-path_desc = os.path.join(path_bids, 'dataset_description.json')
+# path to the project root:
+project_name = 'highspeed-bids'
+path_root = os.getcwd().split(project_name)[0] + project_name
+path_desc = os.path.join(path_root, 'dataset_description.json')
 # ======================================================================
 # UPDATE DATA-SET DESCRIPTION FILE
 # ======================================================================
@@ -33,8 +32,8 @@ json_file.close()
 json_desc["Acknowledgements"] = "This work was funded by a research group grant awarded to NWS by the Max Planck Society (M.TN.A.BILD0004). We thank Eran Eldar, Sam Hall-McMaster and Ondrej Zika for helpful comments on a previous version of this manuscript, Gregor Caregnato for help with participant recruitment and data collection, Anika Loewe, Sonali Beckmann and Nadine Taube for assistance with MRI data acquisition, Lion Schulz for help with behavioral data analysis, Michael Krause for support with cluster computing and all participants for their participation. Lennart Wittkuhn is a pre-doctoral fellow of the International Max Planck Research School on Computational Methods in Psychiatry and Ageing Research (IMPRS COMP2PSYCH). The participating institutions are the Max Planck Institute for Human Development, Berlin, Germany, and University College London, London, UK. For more information, see https://www.mps-ucl-centre.mpg.de/en/comp2psych."
 json_desc["Authors"] = ["Lennart Wittkuhn", "Nicolas W. Schuck"]
 json_desc["Funding"] = ["M.TN.A.BILD0004"]
-json_desc["DatasetDOI"] = "openneuro.org"
-json_desc["License"] = "Creative Commons CC0"
+json_desc["DatasetDOI"] = "https://gin.g-node.org/lnnrtwttkhn/highspeed-bids/"
+json_desc["License"] = "Creative Commons Attribution-NonCommercial-ShareAlike 4.0"
 json_desc["Name"] = "Faster than thought: Detecting sub-second activation sequences with sequential fMRI pattern analysis"
 json_desc["ReferencesAndLinks"] = ["Wittkuhn, L. and Schuck, N. W. (2020). Faster than thought: Detecting sub-second activation sequences with sequential fMRI pattern analysis. bioRxiv. doi: 10.1101/2020.02.15.950667"]
 json_desc["HowToAcknowledge"] = "Please cite: Wittkuhn, L. and Schuck, N. W. (2020). Faster than thought: Detecting sub-second activation sequences with sequential fMRI pattern analysis. bioRxiv. doi: 10.1101/2020.02.15.950667"

dataset_description.json

@@ -1,23 +1,21 @@
 {
-    "Acknowledgements": "TODO: whom you want to acknowledge",
+    "Acknowledgements": "This work was funded by a research group grant awarded to NWS by the Max Planck Society (M.TN.A.BILD0004). We thank Eran Eldar, Sam Hall-McMaster and Ondrej Zika for helpful comments on a previous version of this manuscript, Gregor Caregnato for help with participant recruitment and data collection, Anika Loewe, Sonali Beckmann and Nadine Taube for assistance with MRI data acquisition, Lion Schulz for help with behavioral data analysis, Michael Krause for support with cluster computing and all participants for their participation. Lennart Wittkuhn is a pre-doctoral fellow of the International Max Planck Research School on Computational Methods in Psychiatry and Ageing Research (IMPRS COMP2PSYCH). The participating institutions are the Max Planck Institute for Human Development, Berlin, Germany, and University College London, London, UK. For more information, see https://www.mps-ucl-centre.mpg.de/en/comp2psych.",
     "Authors": [
-        "TODO:",
-        "First1 Last1",
-        "First2 Last2",
-        "..."
+        "Lennart Wittkuhn",
+        "Nicolas W. Schuck"
     ],
     "BIDSVersion": "1.0.1",
-    "DatasetDOI": "TODO: eventually a DOI for the dataset",
+    "DatasetDOI": "https://gin.g-node.org/lnnrtwttkhn/highspeed-bids/",
     "Funding": [
-        "TODO",
-        "GRANT #1",
-        "GRANT #2"
+        "M.TN.A.BILD0004"
     ],
-    "HowToAcknowledge": "TODO: describe how to acknowledge -- either cite a corresponding paper, or just in acknowledgement section",
-    "License": "TODO: choose a license, e.g. PDDL (http://opendatacommons.org/licenses/pddl/)",
-    "Name": "TODO: name of the dataset",
+    "HowToAcknowledge": "Please cite: Wittkuhn, L. and Schuck, N. W. (2020). Faster than thought: Detecting sub-second activation sequences with sequential fMRI pattern analysis. bioRxiv. doi: 10.1101/2020.02.15.950667",
+    "License": "Creative Commons Attribution-NonCommercial-ShareAlike 4.0",
+    "Name": "Faster than thought: Detecting sub-second activation sequences with sequential fMRI pattern analysis",
     "ReferencesAndLinks": [
-        "TODO",
-        "List of papers or websites"
+        "Wittkuhn, L. and Schuck, N. W. (2020). Faster than thought: Detecting sub-second activation sequences with sequential fMRI pattern analysis. bioRxiv. doi: 10.1101/2020.02.15.950667"
+    ],
+    "EthicsApprovals": [
+        "The research protocol was approved by the ethics commission of the German Psychological Society (DPGs), reference number: NS 012018"
     ]
 }