Renames function / adjusts docs

Author: Lucas-Mc

wfdb/__init__.py

@@ -1,5 +1,5 @@
 from wfdb.io.record import (Record, MultiRecord, rdheader, rdrecord, rdsamp,
-                            wrsamp, dl_database, edf2mit, wfdb2edf, wav2mit, wfdb2mat, sampfreq, signame)
+                            wrsamp, dl_database, edf2mit, mit2edf, wav2mit, wfdb2mat, sampfreq, signame)
 from wfdb.io.annotation import (Annotation, rdann, wrann, show_ann_labels,
                                 show_ann_classes, ann2rr)
 from wfdb.io.download import get_dbs, get_record_list, dl_files, set_db_index_url

wfdb/io/__init__.py

@@ -1,5 +1,5 @@
 from wfdb.io.record import (Record, MultiRecord, rdheader, rdrecord, rdsamp, wrsamp,
-                            dl_database, edf2mit, wfdb2edf, wav2mit, wfdb2mat, sampfreq, signame, SIGNAL_CLASSES)
+                            dl_database, edf2mit, mit2edf, wav2mit, wfdb2mat, sampfreq, signame, SIGNAL_CLASSES)
 from wfdb.io._signal import est_res, wr_dat_file
 from wfdb.io.annotation import (Annotation, rdann, wrann, show_ann_labels,
                                 show_ann_classes, ann2rr)

wfdb/io/record.py

@@ -1353,6 +1353,22 @@ def edf2mit(record_name, pn_dir=None, delete_file=True, record_only=False):
     """
     Convert EDF formatted files to MIT format.
 
+    Many EDF files contain signals at widely varying sampling frequencies.
+    `edf2mit` handles these properly, but the default behavior of most WFDB
+    applications is to read such data in low-resolution mode (in which all
+    signals are resampled at the lowest sampling frequency used for any signal
+    in the record). This is almost certainly not what you want if, for
+    example, the record contains EEG signals sampled at 200 Hz and body
+    temperature sampled at 1 Hz; by default, applications such as `rdsamp`
+    will resample the EEGs (and any other signals in the record) at 1 Hz. To
+    avoid this behavior, you can set `smooth_frames` to False (high resolution)
+    provided by `rdrecord` and a few other WFDB applications.
+
+    Note that applications built using version 3.1.0 and later versions of
+    the WFDB-Python library can read EDF files directly, so that the conversion
+    performed by `edf2mit` is no longer necessary. However, one can still use
+    this function to produce WFDB-compatible files from EDF files if desired.
+
     Parameters
     ----------
     record_name : str
@@ -1498,11 +1514,11 @@ def edf2mit(record_name, pn_dir=None, delete_file=True, record_only=False):
         pass
 
 
-def wfdb2edf(record_name, pn_dir=None, sampfrom=0, sampto=None, channels=None,
+def mit2edf(record_name, pn_dir=None, sampfrom=0, sampto=None, channels=None,
              output_filename='', edf_plus=False):
     """
     These programs convert EDF (European Data Format) files into
-    WFDB-compatible files (as used in PhysioBank) and vice versa. European
+    WFDB-compatible files (as used in PhysioNet) and vice versa. European
     Data Format (EDF) was originally designed for storage of polysomnograms.
 
     Note that WFDB format does not include a standard way to specify the
@@ -1511,22 +1527,6 @@ def wfdb2edf(record_name, pn_dir=None, sampfrom=0, sampto=None, channels=None,
     standard signal and unit names specified for EDF is permitted but not
     enforced by `mit2edf`.
 
-    Many EDF files contain signals at widely varying sampling frequencies.
-    `edf2mit` handles these properly, but the default behavior of most WFDB
-    applications is to read such data in low-resolution mode (in which all
-    signals are resampled at the lowest sampling frequency used for any signal
-    in the record). This is almost certainly not what you want if, for
-    example, the record contains EEG signals sampled at 200 Hz and body
-    temperature sampled at 1 Hz; by default, applications such as `rdsamp`
-    will resample the EEGs (and any other signals in the record) at 1 Hz. To
-    avoid this behavior, you can set `smooth_frames` to False (high resolution)
-    provided by `rdrecord` and a few other WFDB applications.
-
-    Note that applications built using version 3.1.0 and later versions of
-    the WFDB-Python library can read EDF files directly, so that the conversion
-    performed by `edf2mit` is no longer necessary. However, one can still use
-    this function to produce WFDB-compatible files from EDF files if desired.
-
     Parameters
     ----------
     record_name : str
@@ -1602,7 +1602,7 @@ def wfdb2edf(record_name, pn_dir=None, sampfrom=0, sampto=None, channels=None,
 
     Examples
     --------
-    >>> wfdb.wfdb2edf('100', pn_dir='pwave')
+    >>> wfdb.mit2edf('100', pn_dir='pwave')
 
     The output file name is '100.edf'