eegdash 0.3.6__py3-none-any.whl → 0.3.6.dev97__py3-none-any.whl

eegdash/__init__.py

@@ -7,4 +7,4 @@ __init__mongo_client()
 
 __all__ = ["EEGDash", "EEGDashDataset", "EEGChallengeDataset"]
 
-__version__ = "0.3.6"
+__version__ = "0.3.6.dev97"

eegdash/registry.py

@@ -57,7 +57,7 @@ def register_openneuro_datasets(
 
         init = make_init(dataset_id)
 
-        doc = f"""Create an instance for OpenNeuro dataset ``{dataset_id}``.
+        doc = f"""OpenNeuro dataset ``{dataset_id}``.
 
         {markdown_table(row_series)}
 
@@ -69,11 +69,15 @@ def register_openneuro_datasets(
             Extra Mongo query merged with ``{{'dataset': '{dataset_id}'}}``.
         s3_bucket : str | None
             Optional S3 bucket name.
+        subject : str | None
+            Optional subject identifier.
+        task : str | None
+            Optional task identifier.
         **kwargs
             Passed through to {base_class.__name__}.
         """
 
-        init.__doc__ = doc
+        # init.__doc__ = doc
 
         cls = type(
             class_name,
@@ -101,6 +105,7 @@ def markdown_table(row_series: pd.Series) -> str:
     """Create a reStructuredText grid table from a pandas Series."""
     if row_series.empty:
         return ""
+    dataset_id = row_series["dataset"]
 
     # Prepare the dataframe with user's suggested logic
     df = (
@@ -112,6 +117,7 @@ def markdown_table(row_series: pd.Series) -> str:
                 "n_tasks": "#Classes",
                 "sampling_freqs": "Freq(Hz)",
                 "duration_hours_total": "Duration(H)",
+                "size": "Size",
             }
         )
         .reindex(
@@ -122,6 +128,7 @@ def markdown_table(row_series: pd.Series) -> str:
                 "#Classes",
                 "Freq(Hz)",
                 "Duration(H)",
+                "Size",
             ]
         )
         .infer_objects(copy=False)
@@ -131,6 +138,9 @@ def markdown_table(row_series: pd.Series) -> str:
     # Use tabulate for the final rst formatting
     table = tabulate(df, headers="keys", tablefmt="rst", showindex=False)
 
+    # Add a caption for the table
+    caption = f"Short overview of dataset {dataset_id} more details in the `Nemar documentation <https://nemar.org/dataexplorer/detail?dataset_id={dataset_id}>`_."
+    # adding caption below the table
     # Indent the table to fit within the admonition block
     indented_table = "\n".join("    " + line for line in table.split("\n"))
-    return f"\n\n{indented_table}"
+    return f"\n\n{indented_table}\n\n{caption}"

{eegdash-0.3.6.dist-info → eegdash-0.3.6.dev97.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.3.6
+Version: 0.3.6.dev97
 Summary: EEG data for machine learning
 Author-email: Young Truong <dt.young112@gmail.com>, Arnaud Delorme <adelorme@gmail.com>, Aviv Dotan <avivd220@gmail.com>, Oren Shriki <oren70@gmail.com>, Bruno Aristimunha <b.aristimunha@gmail.com>
 License-Expression: GPL-3.0-only
@@ -59,6 +59,7 @@ Requires-Dist: numpydoc; extra == "docs"
 Requires-Dist: memory_profiler; extra == "docs"
 Requires-Dist: ipython; extra == "docs"
 Requires-Dist: lightgbm; extra == "docs"
+Requires-Dist: plotly; extra == "docs"
 Provides-Extra: all
 Requires-Dist: eegdash[docs]; extra == "all"
 Requires-Dist: eegdash[dev]; extra == "all"

{eegdash-0.3.6.dist-info → eegdash-0.3.6.dev97.dist-info}/RECORD

@@ -1,4 +1,4 @@
-eegdash/__init__.py,sha256=98fKNGN_Q6JIg7jL9AQtMbxbGDjnzZ8FAroMiRY-7pA,234
+eegdash/__init__.py,sha256=HYsDh0y4j3POtxBWU3sZVZBmB-GK6ty61GwRrsM7cJo,240
 eegdash/api.py,sha256=yotN4vqurZAxVA4q_DK4z0mhh9P8sbpxKzvyxuRSkcQ,38538
 eegdash/data_config.py,sha256=OS6ERO-jHrnEOfMJUehY7ieABdsRw_qWzOKJ4pzSfqw,1323
 eegdash/data_utils.py,sha256=mi9pscui-BPpRH9ovRtGWiSwHG5QN6K_IvJdYaING2I,27679
@@ -6,7 +6,7 @@ eegdash/dataset.py,sha256=iGi7m2FNhLgJxxwSsB9JIy01p4tmdlJIPzdL5CDAJU4,9446
 eegdash/dataset_summary.csv,sha256=9Rw9PawiQ9a_OBRJYKarrzb4UFSGpkGULhYB0MYUieE,14740
 eegdash/mongodb.py,sha256=GD3WgA253oFgpzOHrYaj4P1mRjNtDMT5Oj4kVvHswjI,2006
 eegdash/preprocessing.py,sha256=7S_TTRKPKEk47tTnh2D6WExBt4cctAMxUxGDjJqq5lU,2221
-eegdash/registry.py,sha256=cxqX53GYyDvg5DkiqJkvjqHDPI72JTPlI4qVh2sILu8,3873
+eegdash/registry.py,sha256=jBR2tGE4YJL4yhbZcn2CN4jaC-ttyVN0wmsCR1uWzoU,4329
 eegdash/utils.py,sha256=wU9CBQZLW_LIQIBwhgQm5bU4X-rSsVNPdeF2iE4QGJ4,410
 eegdash/features/__init__.py,sha256=BXNhjvL4_SSFAY1lcP9nyGpkbJNtoOMH4AHlF6OyABo,4078
 eegdash/features/datasets.py,sha256=kU1DO70ArSIy-LF1hHD2NN4iT-kJrI0mVpSkyV_OSeI,18301
@@ -23,8 +23,8 @@ eegdash/features/feature_bank/dimensionality.py,sha256=j_Ds71Y1AbV2uLFQj8EuXQ4kz
 eegdash/features/feature_bank/signal.py,sha256=3Tb8z9gX7iZipxQJ9DSyy30JfdmW58kgvimSyZX74p8,3404
 eegdash/features/feature_bank/spectral.py,sha256=bNB7skusePs1gX7NOU6yRlw_Gr4UOCkO_ylkCgybzug,3319
 eegdash/features/feature_bank/utils.py,sha256=DGh-Q7-XFIittP7iBBxvsJaZrlVvuY5mw-G7q6C-PCI,1237
-eegdash-0.3.6.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
-eegdash-0.3.6.dist-info/METADATA,sha256=jxpD8NJMnPwutQKPSXsL9LsBV5_miObbQy-luSTSUwQ,9919
-eegdash-0.3.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-eegdash-0.3.6.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
-eegdash-0.3.6.dist-info/RECORD,,
+eegdash-0.3.6.dev97.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
+eegdash-0.3.6.dev97.dist-info/METADATA,sha256=FYW3VeKH9zdIRjVdIlE5sjKPIo8Qxs9yAdhfRm31skU,9964
+eegdash-0.3.6.dev97.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+eegdash-0.3.6.dev97.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
+eegdash-0.3.6.dev97.dist-info/RECORD,,