diff --git a/README.md b/README.md index cd7a5fc..377cc22 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,11 @@ There is a `columns` module available, providing constans that define the column ## Avaliable public functions: +All public functions return a [pandas DataFrame][pandas] object. + +Be aware that some columns might contain no values. This is depending on the parsing +method (xml or csv) and if a parameters file could be found or not. + - **parse_folder(path_to_folder)** Tries the `parse_xml_folder()` function first and if an error occurs, it falls back to the `parse_csv_folder()` @@ -88,3 +93,4 @@ To generate the documentation pages use `make docs` or `make serve-docs` for starting a webserver with the generated documentation [sensospot]: https://www.miltenyi-imaging.com/products/sensospot +[pandas]: https://pandas.pydata.org/docs/reference/frame.html \ No newline at end of file diff --git a/src/sensospot_parser/__init__.py b/src/sensospot_parser/__init__.py index 135f9ec..69585b9 100644 --- a/src/sensospot_parser/__init__.py +++ b/src/sensospot_parser/__init__.py @@ -3,7 +3,7 @@ Parsing the numerical output from Sensovations Sensospot image analysis. """ -__version__ = "2.0.1" +__version__ = "2.0.2" import logging import pathlib