paneltime


Namepaneltime JSON
Version 1.2.69 PyPI version JSON
download
home_pageNone
SummaryPanel regression simultaneously solving for ARIMA/GARCH and random/fixed effects.
upload_time2025-08-07 13:36:18
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords econometrics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            


**Paneltime** is a statistical tool for estimating regressions on datasets that:  

- Are **panels** (have both a time and a group dimension)  
- Are **non-stationary in means** (ARIMA)  
- Are **non-stationary in variance** (GARCH)  

Unlike any other statistical tool currently available, **Paneltime** simultaneously handles common timeseries problems 
(**ARIMA**/**GARCH**)  and  *panel data sets* consisting of several groups/individuals 
 (**random/fixed effects**).  

The package can also be used on pure **panel data** sets without ARIMA/GARCH or single time series data with ARIMA/GARCH problems. 

**Author:** Espen Sirnes  
**Current version:** 1.2.68  


# Installation


"pip install paneltime" for installation


# Usage

Datasets are estimated with 

```
paneltime.execute(model_string, dataframe, T,
						ID=None, HF=None,
						instruments=None)
```
It takes the following arguments:

- `model_string`: A string on the form 'Y ~ X1 + X2 + X3', where Y is the dependent and X1-X3 are the independents, as named in the dataframe (required)
- `dataframe`: a dataframe consisting of variables with the names used in `model_string` (required)
- `T`: the time identifier (required)
- `ID`: The group identifier (optional)
- `HF`: list with names of heteroskedasticity factors (optional)
- `instruments`: list with names of instruments (optional)
  
## The model string

The model string can contain operations supported by the `numpy` package, using `np` as alias for numpy. For example `np.abs(x)` will result in a 
variable that is the absolute value of x. 


# Example using world bank data
```python
{{< include example.py >}}
```

[Download working example zip](working_example.zip)




            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "paneltime",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "econometrics",
    "author": null,
    "author_email": "Espen Sirnes <espen.sirnes@uit.no>",
    "download_url": "https://files.pythonhosted.org/packages/dd/ec/19b81835c32b204e3da47b1416cf55ca3b96b86e8c40878b086636121904/paneltime-1.2.69.tar.gz",
    "platform": null,
    "description": "\r\n\r\n\r\n**Paneltime** is a statistical tool for estimating regressions on datasets that:  \r\n\r\n- Are **panels** (have both a time and a group dimension)  \r\n- Are **non-stationary in means** (ARIMA)  \r\n- Are **non-stationary in variance** (GARCH)  \r\n\r\nUnlike any other statistical tool currently available, **Paneltime** simultaneously handles common timeseries problems \r\n(**ARIMA**/**GARCH**)  and  *panel data sets* consisting of several groups/individuals \r\n (**random/fixed effects**).  \r\n\r\nThe package can also be used on pure **panel data** sets without ARIMA/GARCH or single time series data with ARIMA/GARCH problems. \r\n\r\n**Author:** Espen Sirnes  \r\n**Current version:** 1.2.68  \r\n\r\n\r\n# Installation\r\n\r\n\r\n\"pip install paneltime\" for installation\r\n\r\n\r\n# Usage\r\n\r\nDatasets are estimated with \r\n\r\n```\r\npaneltime.execute(model_string, dataframe, T,\r\n\t\t\t\t\t\tID=None, HF=None,\r\n\t\t\t\t\t\tinstruments=None)\r\n```\r\nIt takes the following arguments:\r\n\r\n- `model_string`: A string on the form 'Y ~ X1 + X2 + X3', where Y is the dependent and X1-X3 are the independents, as named in the dataframe (required)\r\n- `dataframe`: a dataframe consisting of variables with the names used in `model_string` (required)\r\n- `T`: the time identifier (required)\r\n- `ID`: The group identifier (optional)\r\n- `HF`: list with names of heteroskedasticity factors (optional)\r\n- `instruments`: list with names of instruments (optional)\r\n  \r\n## The model string\r\n\r\nThe model string can contain operations supported by the `numpy` package, using `np` as alias for numpy. For example `np.abs(x)` will result in a \r\nvariable that is the absolute value of x. \r\n\r\n\r\n# Example using world bank data\r\n```python\r\n{{< include example.py >}}\r\n```\r\n\r\n[Download working example zip](working_example.zip)\r\n\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Panel regression simultaneously solving for ARIMA/GARCH and random/fixed effects.",
    "version": "1.2.69",
    "project_urls": {
        "Homepage": "https://github.com/espensirnes/paneltime"
    },
    "split_keywords": [
        "econometrics"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "193ad99a3c16ca0a6464906d7e1382006def9b28e825e3cde4cd1c816069b1e2",
                "md5": "07a5396630a395e72886afec991a6766",
                "sha256": "7c79aca65efe858cf7ac480ff6b2759d0a615c241440c6be216459d534837737"
            },
            "downloads": -1,
            "filename": "paneltime-1.2.69-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "07a5396630a395e72886afec991a6766",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8271510,
            "upload_time": "2025-08-07T13:36:16",
            "upload_time_iso_8601": "2025-08-07T13:36:16.093872Z",
            "url": "https://files.pythonhosted.org/packages/19/3a/d99a3c16ca0a6464906d7e1382006def9b28e825e3cde4cd1c816069b1e2/paneltime-1.2.69-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ddec19b81835c32b204e3da47b1416cf55ca3b96b86e8c40878b086636121904",
                "md5": "e60fa5d4fe1819920747f0cf4a1be14c",
                "sha256": "79f00157da647fd2836d9811aaea9d76920c3dbcbbdd1e161608a27183ad4aaa"
            },
            "downloads": -1,
            "filename": "paneltime-1.2.69.tar.gz",
            "has_sig": false,
            "md5_digest": "e60fa5d4fe1819920747f0cf4a1be14c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 8181379,
            "upload_time": "2025-08-07T13:36:18",
            "upload_time_iso_8601": "2025-08-07T13:36:18.001456Z",
            "url": "https://files.pythonhosted.org/packages/dd/ec/19b81835c32b204e3da47b1416cf55ca3b96b86e8c40878b086636121904/paneltime-1.2.69.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-07 13:36:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "espensirnes",
    "github_project": "paneltime",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "paneltime"
}
        
Elapsed time: 1.95547s