nipals


Namenipals JSON
Version 0.5.8 PyPI version JSON
download
home_pagehttps://github.com/fredrikw/python-nipals
SummaryA module for calculation of PCA with the NIPALS algorithm
upload_time2024-06-20 13:38:50
maintainerNone
docs_urlNone
authorFredrik Wallner
requires_pythonNone
licenseMIT license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage
            ========
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.8 (2024-06-20)
------------------

* Fix linewidth attributes on plots to allow saving the plots

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": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Fredrik Wallner",
    "author_email": "fredrik@wallner.nu",
    "download_url": "https://files.pythonhosted.org/packages/16/60/0d6b7b0d3f3002923ba62b3a30612f7504f8bcb6320bd32fb1682a322c0b/nipals-0.5.8.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.8 (2024-06-20)\n------------------\n\n* Fix linewidth attributes on plots to allow saving the plots\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.8",
    "project_urls": {
        "Homepage": "https://github.com/fredrikw/python-nipals"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9e2f8ee7a871676be213397d4ba7bcf937bdd86b83df9e9b533522ac6502404",
                "md5": "0a8ac9452174fee93e19ef2ca12f2846",
                "sha256": "0ad47bc6e57a870632f0b598e69ca6c269cb5dd3776f313f1815ec9766154093"
            },
            "downloads": -1,
            "filename": "nipals-0.5.8-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0a8ac9452174fee93e19ef2ca12f2846",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 10788,
            "upload_time": "2024-06-20T13:38:49",
            "upload_time_iso_8601": "2024-06-20T13:38:49.549976Z",
            "url": "https://files.pythonhosted.org/packages/f9/e2/f8ee7a871676be213397d4ba7bcf937bdd86b83df9e9b533522ac6502404/nipals-0.5.8-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "16600d6b7b0d3f3002923ba62b3a30612f7504f8bcb6320bd32fb1682a322c0b",
                "md5": "dc437f6052ef2c54f2f84bbbac66728a",
                "sha256": "8514b27c7816f18104bc131e9a365fed06d71133be4409fc62c901978c6b18d8"
            },
            "downloads": -1,
            "filename": "nipals-0.5.8.tar.gz",
            "has_sig": false,
            "md5_digest": "dc437f6052ef2c54f2f84bbbac66728a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 294828,
            "upload_time": "2024-06-20T13:38:50",
            "upload_time_iso_8601": "2024-06-20T13:38:50.764307Z",
            "url": "https://files.pythonhosted.org/packages/16/60/0d6b7b0d3f3002923ba62b3a30612f7504f8bcb6320bd32fb1682a322c0b/nipals-0.5.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-20 13:38:50",
    "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"
}
        
Elapsed time: 0.56782s