nostocalean


Namenostocalean JSON
Version 0.0.17 PyPI version JSON
download
home_pagehttps://github.com/suproteemsarkar/nostocalean
SummaryCustom utility functions.
upload_time2024-08-07 17:40:33
maintainerNone
docs_urlNone
authorSuproteem Sarkar
requires_python>=3.5
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ===========
Nostocalean
===========

Custom utility functions.

This package contains a collection of utility functions for empirical work in Python.
It's in progress and the API may change often. In addition to custom utility methods,
the package includes wrappers for `fixest <https://github.com/lrberge/fixest>`_ 
and `did <https://github.com/bcallaway11/did>`_.

Example: Given a dataframe ``df`` with columns ``x, y, group_a, group_b`` 
run a regression of ``y`` on ``x`` with group fixed effects, and double cluster:

.. code-block:: python

    from nostocalean import est
    
    summary = est.reg("y ~ x | group_a + group_b", data=df, cluster="~group_a+group_b")
    print(summary)

Example: Given a dataframe ``df`` with columns ``y, first_treat, group, time``
report event study (aggregated group-time) estimates:

.. code-block:: python

    from nostocalean import est

    summary = est.es(y="y", d="first_treat", g="group", t="time", data=df)
    print(summary)

Nostocalean also includes several utility functions, including CES and HARA

Example: To sample a utility function, run:

.. code-block:: python

    from nostocalean import utility_functions
    utility_functions.get_utility_function()

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/suproteemsarkar/nostocalean",
    "name": "nostocalean",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": null,
    "keywords": null,
    "author": "Suproteem Sarkar",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/1b/92/50a1501323cc6e4b5f69238e8f9d75e745910c6cb86c7fa21ed69148d3bb/nostocalean-0.0.17.tar.gz",
    "platform": null,
    "description": "===========\nNostocalean\n===========\n\nCustom utility functions.\n\nThis package contains a collection of utility functions for empirical work in Python.\nIt's in progress and the API may change often. In addition to custom utility methods,\nthe package includes wrappers for `fixest <https://github.com/lrberge/fixest>`_ \nand `did <https://github.com/bcallaway11/did>`_.\n\nExample: Given a dataframe ``df`` with columns ``x, y, group_a, group_b`` \nrun a regression of ``y`` on ``x`` with group fixed effects, and double cluster:\n\n.. code-block:: python\n\n    from nostocalean import est\n    \n    summary = est.reg(\"y ~ x | group_a + group_b\", data=df, cluster=\"~group_a+group_b\")\n    print(summary)\n\nExample: Given a dataframe ``df`` with columns ``y, first_treat, group, time``\nreport event study (aggregated group-time) estimates:\n\n.. code-block:: python\n\n    from nostocalean import est\n\n    summary = est.es(y=\"y\", d=\"first_treat\", g=\"group\", t=\"time\", data=df)\n    print(summary)\n\nNostocalean also includes several utility functions, including CES and HARA\n\nExample: To sample a utility function, run:\n\n.. code-block:: python\n\n    from nostocalean import utility_functions\n    utility_functions.get_utility_function()\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Custom utility functions.",
    "version": "0.0.17",
    "project_urls": {
        "Homepage": "https://github.com/suproteemsarkar/nostocalean"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1b9250a1501323cc6e4b5f69238e8f9d75e745910c6cb86c7fa21ed69148d3bb",
                "md5": "bf64cbc8b6a306d5f1a94f3017f36aeb",
                "sha256": "ca8ad0f45294524854cd775a6ddfcd70d47931f5c9e94243791e8e4a019d8ada"
            },
            "downloads": -1,
            "filename": "nostocalean-0.0.17.tar.gz",
            "has_sig": false,
            "md5_digest": "bf64cbc8b6a306d5f1a94f3017f36aeb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 9467,
            "upload_time": "2024-08-07T17:40:33",
            "upload_time_iso_8601": "2024-08-07T17:40:33.190010Z",
            "url": "https://files.pythonhosted.org/packages/1b/92/50a1501323cc6e4b5f69238e8f9d75e745910c6cb86c7fa21ed69148d3bb/nostocalean-0.0.17.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-07 17:40:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "suproteemsarkar",
    "github_project": "nostocalean",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "nostocalean"
}
        
Elapsed time: 0.47251s