1本のサンプル原稿で、OpenRI の report を最後まで読む。

ローカル環境を用意します

開発 checkout から使う場合は、PDF 抽出、Crossref 照合、API server、テスト用依存をまとめて入れます。

git clone https://github.com/yasufumi-nakata/openri.git
cd openri
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -U pip
pip install -e ".[pdf,image,network,server,dev]"

サンプル原稿を CLI でチェックします

高リスクサンプルには、p 値不整合、透明性項目不足、placeholder DOI、LLM 査読操作指示が入っています。

openri check samples/high_risk_manuscript.txt --strictness strict
openri list --limit 5
openri show <report_id> --json

finding の status を読み分けます

OpenRI では、`skipped` や coverage blocker を合格扱いにしません。どの evidence を人間が確認すべきかを見ます。

Web UI で同じ report を確認します

Web UI はローカル API を呼び出します。未公開原稿を外部 API へ送る構成ではありません。

PYTHONPATH=backend python3 -m uvicorn openri.api:app --host 127.0.0.1 --port 8008

cd frontend
npm install
npm run dev -- --host 127.0.0.1 --port 5173

ブラウザで http://127.0.0.1:5173/ を開き、Run Text または Run PDF/File を実行します。

API で report を取得します

テキスト原稿は JSON、PDF/TXT/MD/TeX/画像ファイルは multipart upload で送ります。

curl -X POST http://127.0.0.1:8008/api/runs \
  -H 'Content-Type: application/json' \
  --data '{"title":"paper","manuscript_text":"Results\n t(58) = 2.15, p = 0.003.","strictness":"standard"}'

curl -X POST http://127.0.0.1:8008/api/runs/upload \
  -F [email protected] \
  -F strictness=strict

GitHub Actions へ組み込みます

原稿リポジトリの pull request で OpenRI を走らせ、必要なら SARIF を Code Scanning に送ります。

- uses: ./.github/actions/openri-check
  with:
    manuscript: manuscripts/submission.pdf
    strictness: strict
    rulesets: "consort mdar_strict"
    fail-on: high
    sarif-path: openri-results.sarif.json
    network: "false"

詳しい workflow は GitHub Action wrapper を参照してください。