Skip to content

add claude.md#58

Open
roninsightrx wants to merge 1 commit intomasterfrom
claude-md
Open

add claude.md#58
roninsightrx wants to merge 1 commit intomasterfrom
claude-md

Conversation

@roninsightrx
Copy link
Copy Markdown
Contributor

No description provided.

Copy link
Copy Markdown

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 CLAUDE.md guide intended for Claude Code usage in this repository, documenting PKPDmap’s purpose, key entry points, common dev commands, and high-level architecture.

Changes:

  • Introduces a repository guidance document (CLAUDE.md) with devtools-based workflows for local development.
  • Documents the estimation methods supported by get_map_estimates() and the main estimation pipeline components.
  • Summarizes key functions, parameter conventions, test layout, and CI behavior.

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

devtools::document()

# Full R CMD check (as done in CI)
devtools::check("--no-manual --as-cran")
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

devtools::check("--no-manual --as-cran") passes both flags as a single argument string; R CMD check expects them as separate args, and this doesn’t match the CI workflow (which passes --no-manual and --as-cran separately). Update the example to pass a character vector of args so local checks behave like CI.

Suggested change
devtools::check("--no-manual --as-cran")
devtools::check(args = c("--no-manual", "--as-cran"))

Copilot uses AI. Check for mistakes.
# Full R CMD check (as done in CI)
devtools::check("--no-manual --as-cran")

# Install PKPDsim dependency from GitHub (requires PAT_TOKEN)
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

The comment says installing from GitHub “requires PAT_TOKEN”, but remotes::install_github() uses the GITHUB_PAT environment variable (and in CI this is populated from the PAT_TOKEN secret). Reword this to avoid confusion for local dev (e.g., mention GITHUB_PAT for local installs and that CI maps it from secrets.PAT_TOKEN).

Suggested change
# Install PKPDsim dependency from GitHub (requires PAT_TOKEN)
# Install PKPDsim dependency from GitHub (requires GITHUB_PAT locally; in CI this comes from secrets.PAT_TOKEN)

Copilot uses AI. Check for mistakes.
```
get_map_estimates()
├── check_inputs() # validate all inputs upfront
├── parse_*()/ # ~10 parse_ functions normalize inputs
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

In the pipeline diagram, parse_*()/ includes a trailing /, which reads like a typo and is inconsistent with the other entries. Consider removing the slash to keep the diagram clean.

Suggested change
├── parse_*()/ # ~10 parse_ functions normalize inputs
├── parse_*() # ~10 parse_ functions normalize inputs

Copilot uses AI. Check for mistakes.
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.

2 participants