========
Overview
========
A module for calculation of PCA and PLS with the NIPALS algorithm. Based on the R packages
`nipals <https://cran.r-project.org/package=nipals>`_ and
`pcaMethods <https://doi.org/10.18129/B9.bioc.pcaMethods>`_ as well as the
statistical appendixes to "Introduction to Multi- and Megavariate Data Analysis
using Projection Methods (PCA & PLS)" by Eriksson et. al.
Tested to give same results as the above packages and Simca, with some rounding errors.
* Free software: MIT license
Installation
============
::
pip install nipals
Documentation
=============
See https://github.com/fredrikw/python-nipals/blob/master/docs/nipals_demo_iris.ipynb
for an example and the tests at https://github.com/fredrikw/python-nipals/tree/master/tests.
Development
===========
To run the all tests run::
tox
Note, to combine the coverage data from all the tox environments run:
.. list-table::
:widths: 10 90
:stub-columns: 1
- - Windows
- ::
set PYTEST_ADDOPTS=--cov-append
tox
- - Other
- ::
PYTEST_ADDOPTS=--cov-append tox
Changelog
=========
0.5.6 (2023-10-20)
------------------
* Updated supported Python versions
0.5.5 (2022-09-28)
------------------
* Added check for X-matrix with row full of NAs
0.5.4 (2021-05-07)
------------------
* Fixed Packaging error (0.5.3 was never released)
0.5.3 (2021-05-06)
------------------
* Fixed error on numpy version >= 1.19
* Updated supported versions
* Moved CI to Github Action (pt 1)
0.5.2 (2019-06-04)
------------------
* Added compatibility with Nipals objects saved from pre-0.5 versions
0.5.1 (2019-05-23)
------------------
* Added checks for, and optional removal of, zero variance in variables
* Added support for Python 3.7
* (0.5.0 was never released due to failing CI tests)
0.4.3 (2018-04-24)
------------------
* Fixed test that failed after last bug fix
0.4.2 (2018-04-24)
------------------
* Fixed bug with selection of starting column for cross validation of PCA
0.4.1 (2018-04-09)
------------------
* Fixed bug with cross validation of PCA
0.4.0 (2018-04-09)
------------------
* Added cross validations
* Added calculation of distance to model with plots
* Added model overview plots
0.3.0 (2018-04-05)
------------------
* Added R2X and R2Y to the PLS class
* Made plot color selectable also for scoreplots without classes
0.2.0 (2018-03-29)
------------------
* Added a PLS class
* Improved plotting
* Fixed some problems with missing/infinite values
0.1.0 (2018-03-14)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/fredrikw/python-nipals",
"name": "nipals",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Fredrik Wallner",
"author_email": "fredrik@wallner.nu",
"download_url": "https://files.pythonhosted.org/packages/93/1a/16b16e84bb402b292245738e3e46b7aa504d57aa24cbc788a6207c7dbf68/nipals-0.5.6.tar.gz",
"platform": null,
"description": "========\nOverview\n========\n\n\n\nA module for calculation of PCA and PLS with the NIPALS algorithm. Based on the R packages\n`nipals <https://cran.r-project.org/package=nipals>`_ and\n`pcaMethods <https://doi.org/10.18129/B9.bioc.pcaMethods>`_ as well as the\nstatistical appendixes to \"Introduction to Multi- and Megavariate Data Analysis\nusing Projection Methods (PCA & PLS)\" by Eriksson et. al.\nTested to give same results as the above packages and Simca, with some rounding errors.\n\n\n* Free software: MIT license\n\nInstallation\n============\n\n::\n\n pip install nipals\n\nDocumentation\n=============\n\nSee https://github.com/fredrikw/python-nipals/blob/master/docs/nipals_demo_iris.ipynb\nfor an example and the tests at https://github.com/fredrikw/python-nipals/tree/master/tests.\n\n\nDevelopment\n===========\n\nTo run the all tests run::\n\n tox\n\nNote, to combine the coverage data from all the tox environments run:\n\n.. list-table::\n :widths: 10 90\n :stub-columns: 1\n\n - - Windows\n - ::\n\n set PYTEST_ADDOPTS=--cov-append\n tox\n\n - - Other\n - ::\n\n PYTEST_ADDOPTS=--cov-append tox\n\nChangelog\n=========\n\n0.5.6 (2023-10-20)\n------------------\n\n* Updated supported Python versions\n\n\n0.5.5 (2022-09-28)\n------------------\n\n* Added check for X-matrix with row full of NAs\n\n0.5.4 (2021-05-07)\n------------------\n\n* Fixed Packaging error (0.5.3 was never released)\n\n0.5.3 (2021-05-06)\n------------------\n\n* Fixed error on numpy version >= 1.19\n* Updated supported versions\n* Moved CI to Github Action (pt 1)\n\n0.5.2 (2019-06-04)\n------------------\n\n* Added compatibility with Nipals objects saved from pre-0.5 versions\n\n0.5.1 (2019-05-23)\n------------------\n\n* Added checks for, and optional removal of, zero variance in variables\n* Added support for Python 3.7\n* (0.5.0 was never released due to failing CI tests)\n\n0.4.3 (2018-04-24)\n------------------\n\n* Fixed test that failed after last bug fix\n\n0.4.2 (2018-04-24)\n------------------\n\n* Fixed bug with selection of starting column for cross validation of PCA\n\n0.4.1 (2018-04-09)\n------------------\n\n* Fixed bug with cross validation of PCA\n\n0.4.0 (2018-04-09)\n------------------\n\n* Added cross validations\n* Added calculation of distance to model with plots\n* Added model overview plots\n\n0.3.0 (2018-04-05)\n------------------\n\n* Added R2X and R2Y to the PLS class\n* Made plot color selectable also for scoreplots without classes\n\n0.2.0 (2018-03-29)\n------------------\n\n* Added a PLS class\n* Improved plotting\n* Fixed some problems with missing/infinite values\n\n0.1.0 (2018-03-14)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A module for calculation of PCA with the NIPALS algorithm",
"version": "0.5.6",
"project_urls": {
"Homepage": "https://github.com/fredrikw/python-nipals"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26f27f940176227f4557839e4b73e5fdb527fafe97602f27227bf9885469fd6d",
"md5": "d4c008af1731d4d0e666ca1d646531f6",
"sha256": "fa1a645cb5eff176a3a43d5d90af1a7b4d9114dbd013f687552a508f07108d39"
},
"downloads": -1,
"filename": "nipals-0.5.6-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4c008af1731d4d0e666ca1d646531f6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 10688,
"upload_time": "2023-10-20T09:38:08",
"upload_time_iso_8601": "2023-10-20T09:38:08.889020Z",
"url": "https://files.pythonhosted.org/packages/26/f2/7f940176227f4557839e4b73e5fdb527fafe97602f27227bf9885469fd6d/nipals-0.5.6-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "931a16b16e84bb402b292245738e3e46b7aa504d57aa24cbc788a6207c7dbf68",
"md5": "ea839d84fb8e3104934faec0967a8771",
"sha256": "4873c679464dcfe47d7214d2c0c338f2b233c1f977d24bf0bba5627208d1c214"
},
"downloads": -1,
"filename": "nipals-0.5.6.tar.gz",
"has_sig": false,
"md5_digest": "ea839d84fb8e3104934faec0967a8771",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 294696,
"upload_time": "2023-10-20T09:38:10",
"upload_time_iso_8601": "2023-10-20T09:38:10.146208Z",
"url": "https://files.pythonhosted.org/packages/93/1a/16b16e84bb402b292245738e3e46b7aa504d57aa24cbc788a6207c7dbf68/nipals-0.5.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-20 09:38:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fredrikw",
"github_project": "python-nipals",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"appveyor": true,
"tox": true,
"lcname": "nipals"
}
JSON
