Adding README table

lcsrodriguez · Jul 11, 2022 · 473d595 · 473d595
1 parent 123c340
commit 473d595
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,20 @@ If you choose the cloning method, please perform a prelinimary step: installing
 
 **Remark**: If you want to clearly uninstall the module, please use: `pip uninstall headat`.
 
+
+## Supported load formats
+
+| Class     | Type        | Description                                                              |
+|-----------|-------------|--------------------------------------------------------------------------|
+| Raw array | `list`      | "Pure" Python array (list of lists)                                      |
+| Raw set   | `set`       | "Pure" Python set (set of lists)                                         |
+| Raw dict  | `dict`      | "Pure" Python dict (dict of lists)                                       |
+| Numpy     | `ndarray`   | Numpy n-dimensions array (for fast computations) (underlying C-layers)   |
+| Pandas    | `Series`    | Pandas Series conversion (for multiple signals, return a list of Series) |
+| Pandas    | `DataFrame` | Pandas DataFrame conversion (best solution for further data processing)  |
+| HDFS      | -           | Hadoop Distributed File System (HDFS) *(using PyArrow)*                  |
+| RDD       | -           | Resilient Distributed Datasets (RDD) *(using PySpark)*                   |
+
 ## Supported export formats
 
 | Name      | Extension      | Description                                                                                     |
@@ -62,6 +76,8 @@ If you choose the cloning method, please perform a prelinimary step: installing
 | Pickle    | `.pkl`         | For data serialization and unserialization (could be useful for such applications)              |
 | SQLite    | `.db, .sqlite` | Classic and light-weight file-based SQL RDBMS (can be relevant for requesting organized records |
 | MATLAB    | `.mat`         | For heavy computations on MATLAB programs (proprietary software)                                |
+| WAV       | `.wav`         | -                                                                                               |
+
 
 
 

diff --git a/headat/constants.py b/headat/constants.py
@@ -1,6 +1,7 @@
 AVAILABLE_EXPORT_TYPES = {
     "text_txt": {
         "ext": "txt",
+        "method": "custom"
     },
     "text_out": {
         "ext": "out",

diff --git a/headat/main.py b/headat/main.py
@@ -211,8 +211,6 @@ def get_records_hashes(self):
     ------------------------------------------------
     1 or more records <-> 1 HDGroup ==> Goal: statistical comparison
         - do the same as with 1 HDView but concat the multiple records side-by-side 
-
-
 """
-Original file line number
+Diff line change
@@ Expand Up / @@ -211,8 +211,6 @@ def get_records_hashes(self): @@
         ------------------------------------------------
 or more records <-> 1 HDGroup ==> Goal: statistical comparison
             - do the same as with 1 HDView but concat the multiple records side-by-side
     """
@@ Expand Down @@