Add page for NWB stats on DANDI (#40)

* Add dandi as a requirement * Add module for computing DANDI NWB file stats * Update conf.py to compute DANDI stats * Add DANDI NWB stats pages to the page index * Update the DANDI stats notebook * Fix line formatting * Update src/nwb_project_analytics/dandistats.py Co-authored-by: Ryan Ly <[email protected]> --------- Co-authored-by: Ryan Ly <[email protected]>
NeurodataWithoutBorders · Jul 29, 2024 · 2a62ff5 · 2a62ff5
1 parent c4f4b47
commit 2a62ff5
Show file tree

Hide file tree

Showing 6 changed files with 980 additions and 198 deletions.
diff --git a/data/dandi_nwb_stats.tsv b/data/dandi_nwb_stats.tsv
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -15,6 +15,7 @@
 import sys
 import sphinx_rtd_theme
 from nwb_project_analytics.create_codestat_pages import create_codestat_pages
+from nwb_project_analytics.dandistats import DANDIStats
 from nwb_project_analytics._version import get_versions
 
 
@@ -200,5 +201,17 @@ def setup(app):
             print_status=True)
     else:
         print("\033[1mSKIPPING: create_codestat_pages... \033[0m done  "
-              "(the existing code_stat_pages up-to-date with the data cache)")
+              "(the existing code_stat_pages are up-to-date with the data cache)")
+
+    if update_code_stat_pages:
+        DANDIStats.create_dandistats_pages(
+            out_dir=code_stat_pages_dir,
+            data_dir=code_stat_data_dir,
+            load_cached_results=True,
+            cache_results=True,
+            print_status=True
+        )
+    else:
+        print("\033[1mSKIPPING: create_dandistats_pages... \033[0m done  "
+              "(the existing dandistats_pages are up-to-date with the data cache)")
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -18,6 +18,11 @@ NWB Software Analytics
 
    code_stat_pages/code_stats_tools.rst
 
+.. toctree::
+   :maxdepth: 2
+
+   code_stat_pages/dandi_nwb_stats.rst
+
 .. toctree::
    :maxdepth: 2
    :caption: Analytics API: