You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@click.option("-o", "--output-path", default=None, type=click.Path(file_okay=True, writable=True), help="The output path or filename for OpenMINDS file/files.")
125
+
@click.option("-o", "--output-path", default=None, type=click.Path(file_okay=True, writable=True), help="The output path or filename for openMINDS file/files.")
126
126
@click.option("--single-file", "multiple_files", flag_value=False, default=False, help="Save the entire collection into a single file (default).")
127
127
@click.option("--multiple-files", "multiple_files", flag_value=True, help="Each node is saved into a separate file within the specified directory. 'output-path' if specified, must be a directory.")
128
128
@click.option("-e", "--include-empty-properties", is_flag=True, default=False, help="Whether to include empty properties in the final file.")
Copy file name to clipboardExpand all lines: docs/source/index.rst
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,12 @@ bids2openminds documentation
9
9
A tool to generate `openMINDS metadata <https://openminds-documentation.readthedocs.io/en/latest/>`_ from `BIDS datasets <https://bids.neuroimaging.io/>`_
10
10
11
11
.. note::
12
-
This project is under active development, please try the first alpha release and send us feedback by creating an issue.
12
+
This project is under active development, please send us feedback by creating an issue.
13
13
14
14
15
-
We are curentlly supporting linux, windows and mac os.
15
+
We are currently supporting Linux, Windows and Mac OS.
Copy file name to clipboardExpand all lines: docs/source/usage.rst
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
Usage
2
2
=====
3
3
4
-
You can use bids2openminds as both a command line tool and a python library.
4
+
You can use bids2openminds as both a command line tool and a Python library.
5
5
6
6
Usage as Python library
7
7
=======================
8
8
9
9
Overview
10
10
########
11
-
The ``convert`` function processes a Brain Imaging Data Structure (BIDS) directory, converts its contents into OpenMINDS format, and optionally saves the output. It handles BIDS layout, extracts relevant information, and creates a dataset description based on BIDS data using OpenMINDS templates.
11
+
The ``convert`` function processes a Brain Imaging Data Structure (BIDS) directory, converts its contents into openMINDS format, and optionally saves the output. It handles BIDS layout, extracts relevant information, and creates a dataset description based on BIDS data using openMINDS templates.
12
12
13
13
14
14
Function Signature
@@ -18,15 +18,15 @@ Function Signature
18
18
Parameters
19
19
##########
20
20
- ``input_path`` (str): Path to the BIDS directory. This is required and must be a valid directory.
21
-
- ``save_output`` (bool, default=False): If True, the converted OpenMINDS data will be saved to the specified output_path.
22
-
- ``output_path`` (str, default=None): The path where the OpenMINDS data should be saved. If not specified, defaults to [``input_path``]/openminds.jsonld (single file mode) or [``input_path``]/openminds/ (multiple files mode).
23
-
- ``multiple_files`` (bool, default=False): If True, the OpenMINDS data will be saved into multiple files within the specified output_path.
21
+
- ``save_output`` (bool, default=False): If True, the converted openMINDS data will be saved to the specified output_path.
22
+
- ``output_path`` (str, default=None): The path where the openMINDS data should be saved. If not specified, defaults to [``input_path``]/openminds.jsonld (single file mode) or [``input_path``]/openminds/ (multiple files mode).
23
+
- ``multiple_files`` (bool, default=False): If True, the openMINDS data will be saved into multiple files within the specified output_path.
24
24
- ``include_empty_properties`` (bool, default=False): If True, includes all the openMINDS properties with empty values in the final output. Otherwise includes only properties that have a non `None` value.
25
25
- ``quiet`` (bool, default=False): If True, suppresses warnings and the final report output. Only prints success messages.
26
26
27
27
Returns
28
28
#######
29
-
- ``collection`` (openminds.Collection): The OpenMINDS collection object representing the converted dataset. For more information on OpenMINDS collection please refer to `openMINDS readthedocs <https://openminds-documentation.readthedocs.io/en/latest/shared/getting_started/openMINDS_collections.html>`_.
29
+
- ``collection`` (openminds.Collection): The openMINDS collection object representing the converted dataset. For more information on openMINDS collection please refer to `openMINDS readthedocs <https://openminds-documentation.readthedocs.io/en/latest/shared/getting_started/openMINDS_collections.html>`_.
30
30
31
31
Example Usage
32
32
#############
@@ -52,10 +52,9 @@ This function is also accessible via a command-line interface using the `click`
52
52
input-path Path to the BIDS directory.
53
53
54
54
Options:
55
-
-o, --output-path PATH The output path or filename for OpenMINDS file/files.
55
+
-o, --output-path PATH The output path or filename for openMINDS file/files.
56
56
--single-file Save the entire collection into a single file (default).
57
57
--multiple-files Save each node into a separate file within the specified directory.
0 commit comments