Skip to content

JOSS submission#17

Merged
TomeHirata merged 14 commits into
mainfrom
feat/joss-paper
Apr 20, 2026
Merged

JOSS submission#17
TomeHirata merged 14 commits into
mainfrom
feat/joss-paper

Conversation

@TomeHirata
Copy link
Copy Markdown
Collaborator

@TomeHirata TomeHirata commented Aug 9, 2024

Added JOSS paper draft and github action to compile the markdown paper into pdf

@TomeHirata TomeHirata marked this pull request as ready for review August 12, 2024 02:10
@TomeHirata TomeHirata marked this pull request as draft August 12, 2024 02:10
Copy link
Copy Markdown
Contributor

@yasui-salmon yasui-salmon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

簡単にコメント入れました

Comment thread paper.md Outdated
Comment thread paper.md Outdated
TomeHirata and others added 3 commits March 31, 2026 19:57
- Add "(RCTs, also known as A/B tests)" clarification per reviewer feedback
- Add DoWhy and EconML comparison in Statement of Need section
- Add imperfect compliance paper reference for LDTE estimators
- Update CAR paper to ICML'25 proceedings format with updated author list
- Update multi-task learning paper author list (add Shunsuke Uto)
- Fix Fisher citation key to match bibliography

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@TomeHirata TomeHirata marked this pull request as ready for review March 31, 2026 11:07
Copilot AI review requested due to automatic review settings March 31, 2026 11:07
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a draft JOSS manuscript for the dte_adj package, documenting its motivation, core estimators/methods, and related literature for submission.

Changes:

  • Introduces paper.md with JOSS front-matter, summary/need statements, and a feature overview (including linked figures).
  • Adds paper.bib with bibliography entries referenced from the manuscript.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
paper.md New JOSS paper draft (front-matter + narrative + figures) describing dte_adj and its capabilities.
paper.bib New bibliography backing citations used in paper.md.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread paper.md Outdated
Comment thread paper.bib Outdated
@TomeHirata TomeHirata changed the title Draft for JOSS submission JOSS submission Mar 31, 2026
TomeHirata and others added 3 commits March 31, 2026 20:42
- Add required "State of the Field" section comparing with SciPy, DoWhy,
  EconML, and causal-curve packages
- Add required "Software Design" section explaining class architecture
- Add required "Research Impact Statement" with ICML publications and
  industry usage
- Add required "AI Usage Disclosure" section
- Remove detailed "Features" section (API docs belong in documentation)
- Add SciPy and causal-curve references to bibliography
- Ensure word count is within 750-1750 range (776 words)
- Add VanderPlas to typos allowlist (author name in SciPy citation)

References:
- JOSS submission guidelines: https://joss.readthedocs.io/en/latest/paper.html
- JOSS review checklist: https://github.com/openjournals/joss/blob/main/docs/review_checklist.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Fix author metadata: make Tomu Hirata the single corresponding author
  and remove conflicting equal-contrib flag
- Fix NumPy citation: replace Unicode en-dash (–) with BibTeX format (--)
  for compatibility across citation pipelines

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Move paper.md and paper.bib into paper/ to avoid top-level clutter
- Add hillstorm_dte.png and oregon_ldte_costs_comparison.png from tutorials
- Add figure captions showing simple vs ML-adjusted comparison for both
  the Hillstrom email campaign and Oregon Health Insurance Experiment
- Cross-reference figures in Research Impact Statement
- Add dataset citations (Hillstrom 2008, Finkelstein et al. 2012)
- Add GitHub Action (draft-pdf.yml) to auto-build JOSS PDF on push
  using paper-path: paper/paper.md

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Comment thread .github/workflows/draft-pdf.yml Fixed
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Comment thread .github/workflows/draft-pdf.yml Fixed
TomeHirata and others added 6 commits April 8, 2026 21:52
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Addresses CodeQL security alert: restrict GITHUB_TOKEN to read-only
contents access following least-privilege principle.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
inara/pandoc runs from the repo root, so relative image paths in
paper/paper.md resolve against root, not paper/. Copy PNGs to root
before the build step so pandoc finds them.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Pandoc extracts \label{} from caption text and also auto-generates a
figure label, causing the label to be defined twice. Remove explicit
\label{} from captions and replace \autoref{} with plain text references.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
inara CDs into the paper/ directory before running pandoc, so images
in paper/ are already on the resource path. No copying needed.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@yasui-salmon yasui-salmon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’ve added some brief comments regarding the citations.

Comment thread paper/paper.md Outdated
- Add Econometric Reviews publication (Oka et al. 2025)
- Add NeurIPS 2025 reference for imperfect compliance paper
- Add ABEMA field experiment paper (Yasui et al. 2026, Japanese Economic
  Review) as industry application evidence

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@TomeHirata TomeHirata merged commit 754bade into main Apr 20, 2026
10 checks passed
@TomeHirata TomeHirata deleted the feat/joss-paper branch April 20, 2026 05:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants