include description of config in docstring
@@ -358,6 +358,21 @@ def expected_file_check(layout, config):
# Put example output here
>>> problem_df
# Put example output here
+
+
+ Notes
+ --------
+ The configuration file must contain the following keys:
+ "modality"
+ "session"
+ "type"
+ "runs"
+
+ Additional keys matching the inputs for `layout.get` may also be added
+ (e.g. 'task' for functionals).
+ Values shoud match those in the BIDS file names. See the sample config
+ for an example (bids/layout/tests/data/sample_validation_config.json)
+
"""
summary_df = pd.DataFrame(columns=['subject', 'session', 'modality', 'task', 'runs', 'runs_found', 'problem'])
