add examples to docstring
@@ -76,6 +76,26 @@ class NwbRecordingExtractor(BaseRecording):
-------
recording: NwbRecordingExtractor
The recording extractor for the NWB file
+
+ Examples
+ --------
+ run on local file
+
+ >>> from spikeinterface.extractors.nwbextractors import NwbRecordingExtractor
+ >>> rec = NwbRecordingExtractor(s3_url, driver="ros3")
+
+ run on s3 URL from the DANDI Archive
+
+ >>> from spikeinterface.extractors.nwbextractors import NwbRecordingExtractor
+ >>> from dandi.dandiapi import DandiAPIClient
+ >>>
+ >>> # get s3 path
+ >>> dandiset_id, filepath = "101116", "sub-001/sub-001_ecephys.nwb"
+ >>> with DandiAPIClient("https://api-staging.dandiarchive.org/api") as client:
+ >>> asset = client.get_dandiset(dandiset_id, "draft").get_asset_by_path(filepath)
+ >>> s3_url = asset.get_content_url(follow_redirects=1, strip_query=True)
+ >>>
+ >>> rec = NwbRecordingExtractor(s3_url, driver="ros3")
"""
self.driver = driver
check_nwb_install()
