NScluster

Simulation and estimation of the Neyman-Scott type spatial cluster models


統計数理研究所

2023年3月 (Ver. 1.3.6-1)


1. はじめに

 Rパッケージ NSclusterは,ネイマン・スコット型空間クラスターモデルのシミュレーションとパラメータ推定のための関数群である. これらの関数はComputer Science Monographs No.34 (Tanaka et al. [1]) のFORTRANプログラムをもとに開発されたが,その手法は「Parameter Estimation and Model Selection for Neyman-Scott Point Process」(Tanaka et al.[2]) で提案されたネイマン-スコット型点過程のパラメータ評価法である.ここで仮定されるモデルは,トーマスモデルとその拡張モデル(タイプA,タイプB,タイプC) および逆べき乗型モデルの5種類である.

 バージョン 1.1.0以降では,比較的時間がかかるシンプレックス法によるパラメータ推定の計算処理の部分をOpenMPを使って並列化している.
また,バージョン 1.3.1以降では,ブートストラップ法によるパラメータ推定値の信頼区間を求める関数が付け加えられた.

 本パッケージの実行例と詳細については,「NScluster: An R Package for Maximum Palm Likelihood Estimation for Cluster Point Process Models Using OpenMP」(Tanaka et al.[3])を参照のこと.


2. パッケージ NSclusterの関数

パッケージのの機能は,以下の4つである.

(1) ネイマン-スコット型モデルとその拡張モデルのシミュレーション
(2) シンプレックス法によるパラメータの推定
(3) ブートストラップ法によるパラメータ推定値の信頼区間
(4) パラメトリックとノンパラメトリックなパルム強度関数の計算

下図は,トーマスモデルのシミュレーション結果と,そのシミュレーション結果のパラメータ推定値のパルム強度関数の表示例である.

SimulateThomas()の実行結果
PalmThomas()の実行結果

3.Rのインストール

ここでは,Windows版 Rのインストール方法について簡単に説明する.Linux版や他のバージョンのインストール方法については,RjpWiki を参照のこと.

(1) CRAN のミラーサイト (統計数理研究所)の · Download R for Windows をクリック,実行ファイル R-4.2.3-win.exe をダウンロードする.

(2) 実行ファイルをダブルクリックしてインストーラを起動する.表示画面に従ってセットアップに使用する言語「日本語」を選択 (OK) し,セットアップウィザートを開始し完了画面まで進み (完了) をクリックする.


4. パッケージNSclusterのインストールとロード

本ページからは,NSclusterパッケージ のWindows用バイナリファイル,Linux用のソースファイルがダウンロードできる. これらはそれぞれ Windows11 (R-4.2.1) および Ubuntu 20.04 LTS (R-4.2.2 Patched) で動作確認をしたものである. なお CRANの拡張パッケージ (Contributed Packages) として登録されており, こちら のサイトからもダウンロードできる.

4.1 Windowsの場合

(1) バイナリファイル NScluster_1.3.6-1.zip を適当なフォルダにダウンロードする.

(2) R(RGui)を起動し,メニュー [Packages] から

   --> Install package(s) from local zip files...--> Select files で NScluster_1.3.6-1.zip を選択.

(3) メニュー [Package] から

   --> Load Package.. --> Select one で NScluster を選択.

4.2 Linuxの場合

(1) ソースファイル NScluster_1.3.6-1.tar.gz を適当なディレクトリにダウンロードする.

(2) スーパーユーザになりインストールする.

   # R CMD INSTALL NScluster_1.3.6-1.tar.gz

(3) Rを起動しNSclusterを呼び出す.

   $ R
   > library(NScluster)


5. OpenMP の環境変数 OMP_NUM_THREADS

OpenMP は環境変数 OMP_NUM_THREADS により使用するスレッド数が決定される.デフォルトでは,利用可能なスレッド数である.
この環境変数を変更したい場合は,以下のような方法がある.

5.1 Windowsの場合

 コマンドプロンプトで

   > set OMP_NUM_THREADS= <使用するスレッド数>

 を実行するか,コントロール・パネルを利用して設定する.

5.2 Linuxの場合

 ターミナルで

   $ export OMP_NUM_THREADS= <使用するスレッド数>

 を実行する.


6. ヘルプの使い方

 パッケージの概要については,R(RGui)を起動後

   > help(NScluster)

 を実行する.

 Reference manual: NScluster-manual.pdf
 Vignettes: A Giuide of NScluster (NScluster.pdf)


7. Reference

(1) U. Tanaka, Y. Ogata and K. Katsura (2008). Simulation and estimation of the Neyman-Scott type spatial cluster models, Computer Science Monographs, No.34, 1-44, The Institute of Statistical Mathematics, Tokyo.

(2) U. Tanaka, Y. Ogata and D. Stoyan (2008). Parameter estimation and model selection for Neyman-Scott point processes, Biometrical Journal 50, 43-57.

(3) U. Tanaka, M. Saga and J. Nakano (2021). NScluster: An R Package for Maximum Palm Likelihood Estimation for Cluster Point Process Models Using OpenMP, Journal of Statistical Software, Articles, 98(6), 1-22. doi: 10.18637/jss.v098.i06.



本パッケージに関するバグ報告等がありましたら ismrp(at)grp.ism.ac.jp 宛お寄せ下さい.