Metadata-Version: 2.1
Name: py4macro
Version: 0.2.0
Summary: Module for py4macro.github.io
Home-page: https://github.com/Py4Macro/py4macro
Author: Tetsu Haruyama
Author-email: haruyama@econ.kobe-u.ac.jp
License: MIT
Description: # はじめに
        
        [「Pythonで学ぶ中級マクロ経済学」](https://py4macro.github.io)で使うモジュール。
        
        以下が含まれている。
        * Hodrick-Prescottフィルターを使い時系列データのトレンドを返す関数
        * DataFrameを全て表示するshow関数
        * ３つのデータ・セット
            * Penn World Tables 10.0
            * IMF World Economic Outlook 2021
            * Maddison Project Database 2020
        
        # 使い方
        ```
        import py4macro
        ```
        
        ## Hodrick-Prescottフィルターによるトレンド抽出
        
        ```
        py4macro.trend(s,lamb=1600)
        ```
        **引数**:
        
        * `s`：`Series`もしくは１列の`DataFrame`とし，行のラベルは`DatetimeIndex`にすること。
        * lamb: HPフィルターのlambda（デフォルトは四半期用のデータでは通常の値である1600としている）
        
        **返り値**:
        
        Hodrick-Prescottフィルターで計算したtrend（トレンド）の`Series`
        
        
        **例**:
        
        `py4macro.trend(df.loc[:,'gdp'])`
        
        
        ## DataFrameの行・列を全て表示する
        ```
        py4macro.show(df)
        ```
        **引数**：
        * `df`：`DataFrame`
        
        **返り値**：
        
        `DataFrame`の表示のみ
        
        
        ## ３つのデータ・セット
        
        ```
        py4macro.data(dataset=None, description=0)
        ```
        
        **引数**：
        
        * `dataset`: (文字列)
            * `'pwt'`:   Penn World Table 10.0
            * `'weo'`:   IMF World Economic Outlook 2021
            * `'mad'`:   country data of Maddison Project Database 2020
            * `'mad-regions'`:   regional data of Maddison Project Database 2020
        
        * `description` (デフォルト：`0`, 整数型):
            * `0`: データのDataFrameを返す
            * `1`: 変数の定義を全て表示する
            * `2`: 変数の定義のDataFrameを返す
            * `-1`: 何年以降から予測値なのかを全て示す(`dataset='weo'`場合にのみ有効)
            * `-2`: 何年以降から予測値なのかを示すDataFrameを返す(`dataset='weo'`場合にのみ有効)
        
        **返り値**：
            `DataFrame`もしくは`DataFrame`の表示
        
        
        例１：IMF World Economic OutlookのDataFrameを返す
        
        `py4macro.data('weo')`
        
        例２：IMF World Economic Outlookの変数定義の全てを表示する
        
        `py4macro.data('weo',description=1)`
        
        例３：IMF World Economic Outlookの変数定義のDataFrameを返す
        
        `py4macro.data('weo',description=2)`
        
        例４：IMF World Economic Outlookの変数の推定値の開始年を全て表示する
        
        `py4macro.data('weo',description=-1)`
        
        例５：IMF World Economic Outlookの変数の推定値の開始年のDataFrameを返す
        
        `py4macro.data('weo',description=-2)`
        
        
        # インストール方法
        ```
        pip install py4macro
        ```
        or
        ```
        pip install git+https://github.com/Py4Macro/py4macro.git
        ```
        or
        ```
        git clone https://github.com/Py4Macro/py4macro.git
        cd py4macro
        pip install .
        ```
        
Keywords: data,Penn World Table,IMF World Economic Outlook,Maddison Project,Hodrick-Prescott filter
Platform: UNKNOWN
Description-Content-Type: text/markdown
