rpy2に関して、Rのディレクトリの場所をどのように特定しているのでしょうか

Question

<環境>
os:windows10
実行環境:anaconda3 - jupyter notebook
主要ライブラリ:rpy2 3.7

〈本文〉
pythonでRを使用するためのrpy2というライブラリについて質問です。python環境下でrpy2を利用してRを使用することに成功しました。一つ疑問なのですが、タイトルにもあるとおり、rpy2はどのようにしてRのディレクトリの特定をしているのでしょうか。例えば、Rのディレクトリの場所を移動させた場合、rpy2は機能しなくなるのでしょうか。
また、rpy2が参照しているRのディレクトリへのPATHを表示させる方法はありますでしょうか。

〈補足〉
実はR本体をインストールする際に、公式のRとanaconda-navigatorを使用してconda環境下のRの両方を以前インストールしました。そして、新しくRのライブラリ(以下Xとする)をconda環境下でインストールしてrpy2を利用しpython環境下で使用しようと試みたところXが見つかりませんでしたというエラーを検出しました。
そこで、Xを、「conda環境のディレクトリ」から「R公式からRのライブラリが格納されているディレクトリ」に、ドラッグ＆ドロップで移動させたところ、うまく行きました。
つまり、rpy2が参照していたのはR公式からインストールしていたRでした。

Answer 1

以下の get_r_exec() で R のパスを決定しています。

get_r_exec() rpy2/situation.py at master · rpy2/rpy2

def get_r_exec(r_home: str) -> str:
    """Get the path of the R executable/binary.

    :param: R HOME directory
    :return: Path to the R executable/binary"""

    if sys.platform == 'win32' and '64 bit' in sys.version:
        r_exec = os.path.join(r_home, 'bin', 'x64', 'R')
    else:
        r_exec = os.path.join(r_home, 'bin', 'R')
    return r_exec

この関数の引数 r_home ですが、get_r_home() 関数の戻り値になります。

get_r_home() rpy2/situation.py at master · rpy2/rpy2

def get_r_home() -> Optional[str]:
    """Get R's home directory (aka R_HOME).

    If an environment variable R_HOME is found it is returned,
    and if none is found it is trying to get it from an R executable
    in the PATH. On Windows, a third last attempt is made by trying
    to obtain R_HOME from the registry. If all attempt are unfruitful,
    None is returned.
    """

    r_home = os.environ.get('R_HOME')

    if not r_home:
        r_home = r_home_from_subprocess()
    if not r_home and os.name == 'nt':
        r_home = r_home_from_registry()
    return r_home

環境変数 R_HOME が設定されていればそれを使いますが、設定されていない場合は r_home_from_subprocess() を実行します。具体的には R RHOME を実行しています。

r_home_from_subprocess() rpy2/situation.py at master · rpy2/rpy2

def r_home_from_subprocess() -> Optional[str]:
    """Return the R home directory from calling 'R RHOME'."""
    try:
        tmp = subprocess.check_output(('R', 'RHOME'), universal_newlines=True)
    except Exception:  # FileNotFoundError, WindowsError, etc
        return None
    r_home = tmp.split(os.linesep)
    if r_home[0].startswith('WARNING'):
        res = r_home[1]
    else:
        res = r_home[0].strip()
    return res

つまり、

1. R_HOME 環境変数が設定されている
   R_HOME 環境変数から R に実行バイナリのパスを決定。

2. R_HOME 環境変数が設定されていない
   R RHOME の実行結果から R の home directory を取得して R の実行バイナリのパスを決定。

となります。

>>> import sys
>>> sys.platform
'linux'

>>> import rpy2.situation
>>> rpy2.situation.get_r_exec(rpy2.situation.get_r_home())
'/usr/lib/R/bin/R'

$ R RHOME
/usr/lib/R
$ ls -l $(R RHOME)/bin/R
-rwxr-xr-x 1 root root /usr/lib/R/bin/R

Comments

[shihatu]

非常に完結かつ丁寧な回答ありがとうございます。理解できました。