Skip to content

Commit e75bc56

Browse files
cx1111cx1111
committed
doc
1 parent a618e15 commit e75bc56

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

‎README.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Constructor function:
120120
def __init__(self, recordname, annotator, annsamp, anntype, subtype = None,
121121
chan = None, num = None, aux = None, fs = None)
122122

123-
Call 'showanncodes()' to see the list of standard annotation codes. Any text used to label annotations that are not one of these codes should go in the 'aux' field rather than the 'anntype' field.
123+
Call `showanncodes()` to see the list of standard annotation codes. Any text used to label annotations that are not one of these codes should go in the 'aux' field rather than the 'anntype' field.
124124

125125
Example usage:
126126
::
@@ -193,7 +193,7 @@ Output arguments:
193193
Writing Signals
194194
~~~~~~~~~~~~~~~
195195

196-
The Record class has a **wrsamp** instance method for writing wfdb record files. Create a valid Record object and call ``record.wrsamp()``. If you choose this more advanced method, see also the setdefaults(), set_d_features, and set_p_features instance methods to help populate attributes. In addition, there is also the following simpler module level **wrsamp** function.
196+
The Record class has a **wrsamp** instance method for writing wfdb record files. Create a valid Record object and call ``record.wrsamp()``. If you choose this more advanced method, see also the `setdefaults`, `set_d_features`, and `set_p_features` instance methods to help populate attributes. In addition, there is also the following simpler module level **wrsamp** function.
197197

198198

199199
**wrsamp** - Write a single segment WFDB record, creating a WFDB header file and any associated dat files.
@@ -336,7 +336,7 @@ Input Arguments:
336336

337337
- ``record`` (required): A wfdb Record object. The p_signals attribute will be plotted.
338338
- ``title`` (default=None): A string containing the title of the graph.
339-
- ``annotation (default=None): An Annotation object. The annsamp attribute locations will be overlaid on the signal.
339+
- ``annotation`` (default=None): An Annotation object. The annsamp attribute locations will be overlaid on the signal.
340340
- ``annch`` (default=[0]): A list of channels on which to plot the annotation samples.
341341
- ``timeunits`` (default='samples'): String specifying the x axis unit. Allowed options are: 'samples', 'seconds', 'minutes', and 'hours'.
342342
- ``returnfig`` (default=False): Specifies whether the figure is to be returned as an output argument
@@ -366,7 +366,7 @@ Input Arguments:
366366

367367
- ``annotation`` (required): An Annotation object. The annsamp attribute locations will be overlaid on the signal.
368368
- ``title`` (default=None): A string containing the title of the graph.
369-
- ``annotation (default=None): An Annotation object. The annsamp attribute locations will be overlaid on the signal.
369+
- ``annotation`` (default=None): An Annotation object. The annsamp attribute locations will be overlaid on the signal.
370370
- ``timeunits`` (default='samples'): String specifying the x axis unit. Allowed options are: 'samples', 'seconds', 'minutes', and 'hours'.
371371
- ``returnfig`` (default=False): Specifies whether the figure is to be returned as an output argument
372372

@@ -376,7 +376,7 @@ Output argument:
376376
Downloading Physiobank Content
377377
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
378378

379-
Download files from various Physiobank databases. The Physiobank index page lists all available databases is located at http://physionet.org/physiobank/database
379+
Download files from various Physiobank databases. The Physiobank index page located at http://physionet.org/physiobank/database lists all available databases.
380380

381381

382382
**getdblist** - Return a list of all the physiobank databases available.
@@ -408,9 +408,7 @@ Example Usage:
408408
Input arguments:
409409
- ``pbdb`` (required): The Physiobank database directory to download. eg. For database 'http://physionet.org/physiobank/database/mitdb', pbdb = 'mitdb'.
410410
- ``dlbasedir`` (required): The full local directory path in which to download the files.
411-
- ``records`` (default='all'): Specifier of the WFDB records to download. Is either a list of strings
412-
which each specify a record, or 'all' to download all records listed in the database's RECORDS file.
413-
eg. records = ['test01_00s', test02_45s] for database https://physionet.org/physiobank/database/macecgdb/
411+
- ``records`` (default='all'): Specifier of the WFDB records to download. Is either a list of strings which each specify a record, or 'all' to download all records listed in the database's RECORDS file. eg. records = ['test01_00s', test02_45s] for database https://physionet.org/physiobank/database/macecgdb/
414412
- ``annotators`` (default='all'): Specifier of the WFDB annotation file types to download along with the record files. Is either None to skip downloading any annotations, 'all' to download all annotation types as specified by the ANNOTATORS file, or a list of strings which each specify an annotation extension. eg. annotators = ['anI'] for database https://physionet.org/physiobank/database/prcp/
415413
- ``keepsubdirs`` (default=True): Whether to keep the relative subdirectories of downloaded files as they are organized in Physiobank (True), or to download all files into the same base directory (False).
416414
- ``overwrite`` (default=False): If set to True, all files will be redownloaded regardless. If set to False, existing files with the same name and relative subdirectory will be checked. If the local file is the same size as the online file, the download is skipped. If the local file is larger, it will be deleted and the file will be redownloaded. If the local file is smaller, the file will be assumed to be partially downloaded and the remaining bytes will be downloaded and appended.

‎wfdb/records.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -990,7 +990,7 @@ def wrsamp(recordname, fs, units, signames, p_signals = None, d_signals = None,
990990
the most frequently used parameters. Therefore not all WFDB fields can be set via this function.
991991
992992
For more control over attributes, create a wfdb.Record object, manually set its attributes, and
993-
call its wrsamp() instance method. If you choose this more advanced method, see also the setdefaults(),
993+
call its wrsamp() instance method. If you choose this more advanced method, see also the setdefaults,
994994
set_d_features, and set_p_features instance methods to help populate attributes.
995995
996996
Example Usage (with the most common scenario of input parameters):

0 commit comments

Comments
 (0)