Skip to content

Commit 45f8c4b

Browse files
committed
docstring and notebook update
1 parent 6a4f6ed commit 45f8c4b

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

notebooks/conversion_tutorial.ipynb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@
4848
"Where the nwb file will be saved. For Frank Lab members, this should be `/stelmo/nwb/raw/`. File is named by the convention {animal}{date}.nwb\n",
4949
"\n",
5050
"+ `query_expression`: A query expression to select which files to convert. For example, if you have several animals in your folder, you could write `\"animal == 'sample'\"` to select only the sample animal. Defaults to `None` which converts all files in the directory (potentially overwriting ones you've done before!).\n",
51+
"\n",
52+
"+ `behavior_only`: Rec files recorded through trodes software without e-phys data have a\n",
53+
" different expected internal structure. Use this flag to ensure correct data parsing \n",
54+
" is used. Default of `True` expects electrophysiology data to be present\n",
5155
"\n"
5256
]
5357
},

src/trodes_to_nwb/convert.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,9 @@ def create_nwbs(
139139
See https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.query.html.
140140
disable_ptp : bool, optional
141141
Blocks use of ptp timestamps regardless of rec header, by default False.
142+
behavior_only : bool, optional
143+
Flag to indicate only behaviorsl data (no ephys) was collected in the rec
144+
files, by default False.
142145
143146
"""
144147

0 commit comments

Comments
 (0)