Skip to content

Document minimal Shiny UI config for advanced models#36

Merged
seonghobae merged 5 commits intodevelopfrom
issue-35-shiny-ui
Feb 14, 2026
Merged

Document minimal Shiny UI config for advanced models#36
seonghobae merged 5 commits intodevelopfrom
issue-35-shiny-ui

Conversation

@seonghobae
Copy link
Copy Markdown
Owner

Summary

  • document the minimal Shiny UI inputs needed to expose advanced model settings

Testing

  • not run (docs only)

Closes #35

Copilot AI review requested due to automatic review settings January 9, 2026 11:59
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 9, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Summary by CodeRabbit

문서화

  • README 안내가 개선되었습니다.
  • 고급 모델을 위한 최소 UI 구성 옵션에 관한 새로운 섹션이 추가되었습니다.
  • 선택적 UI 제어 기능과 매핑 정보가 포함되었습니다.
  • 분석 중 진행률 표시에 대한 안내가 추가되었습니다.
  • 문서의 가독성을 개선하기 위해 형식이 재정리되었습니다.

Walkthrough

inst/shiny-app/README.md에 "Minimal UI Configuration for Advanced Models" 섹션을 추가하고, 관련 문장 리플로우와 목록 형식 수정을 적용했습니다. 실행 로직이나 공개 API 변경은 없습니다. (문서 텍스트 변경만 있음, 0개의 코드 변경)

Changes

Cohort / File(s) Summary
문서 — Shiny README
inst/shiny-app/README.md
고급 모델 설정을 노출하기 위한 최소 Shiny UI 구성 섹션 추가(설정: minExtraction, maxExtraction, rotate, modelSelectionCriteria, saveModelHistory) 및 해당 aefa() 파라미터 매핑과 검증 노트 삽입. CSV 업로드 및 분석 진행 표시 관련 문장 이동·확장, 예시/데이터 설명 문장 리플로우 및 정리. 모든 변경은 문서 텍스트 수정에 한정됨.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 README 속에 살금살금,
고급 설정 한 줄 올려두고,
UI와 함수가 손을 잡게,
작은 안내로 길을 비추네.
토끼가 축하해요, 통통! 🥕✨

🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Title check ✅ Passed 제목이 pull request의 주요 변경사항을 명확하게 요약하고 있습니다. README.md 문서에 고급 모델을 위한 최소 Shiny UI 구성에 대한 설명을 추가하는 것이 주된 변경사항이며, 제목이 이를 정확히 반영하고 있습니다.
Description check ✅ Passed 설명이 변경사항과 관련이 있습니다. 고급 모델 설정을 노출하기 위한 최소 Shiny UI 입력 문서화 목표와 이슈 #35를 언급하고 있으며, 문서 전용 변경임을 명시하고 있습니다.
Linked Issues check ✅ Passed Pull request가 이슈 #35의 요구사항을 충족합니다. README.md에 고급 모델 설정(minExtraction/maxExtraction, rotate, modelSelectionCriteria, saveModelHistory)을 노출하는 최소 Shiny UI 구성을 문서화하고, aefa() 매개변수와의 매핑을 설명하고 있습니다.
Out of Scope Changes check ✅ Passed 모든 변경사항이 README.md 문서에만 적용되며, 이슈 #35의 범위 내에 있습니다. 실행 가능한 로직이나 데이터 처리 코드에 대한 변경이 없고, 순수 문서 업데이트입니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into develop

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch issue-35-shiny-ui

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@seonghobae
Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 14, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

1 similar comment
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 14, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot]
coderabbitai Bot previously requested changes Feb 14, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
inst/shiny-app/README.md (1)

25-28: ⚠️ Potential issue | 🟡 Minor

기존 문서와의 일관성 검토 필요

25-28번째 줄의 "Configure Model" 섹션에서는 3가지 구성 옵션(요인 범위, 회전 방법, 모델 선택 기준)만 언급하는 반면, 새로 추가된 55-56번째 줄에서는 saveModelHistory를 "권장(recommended)" 옵션으로 소개하고 있습니다.

만약 saveModelHistory가 고급 설정을 위한 중요한 옵션이라면, "Using the Interface" 섹션에도 언급되어야 일관성이 유지됩니다.

📝 일관성 개선을 위한 제안

"Configure Model" 섹션에 saveModelHistory 옵션 추가:

 2. **Configure Model**:
    - Set minimum and maximum number of factors to explore
    - Choose rotation method (bifactorQ recommended for most cases)
    - Select model selection criteria (DIC is default)
+   - Enable model history saving to inspect candidate models (optional but recommended)

Also applies to: 55-56

🤖 Fix all issues with AI agents
In `@inst/shiny-app/README.md`:
- Around line 58-59: The sentence containing "These controls, along with data
upload/validation and a run button, are the minimum set..." is ambiguous about
whether "data upload/validation" and the "run button" are part of the UI
controls or separate implementation tasks and what "data validation" entails;
update the README text to explicitly state whether these elements are UI
components or backend steps and provide a short concrete definition of "data
validation" (e.g., schema/type checks, missing-value handling, and format
validation) and list which parts must be implemented in the UI versus server
logic so readers know exactly what to build and where (refer to the exact phrase
"data upload/validation and a run button" to find the sentence to edit).
- Around line 44-60: Update the README examples to include the full set of
supported model selection criteria and to mention the model history toggle: add
`AICc` and `saBIC` to the "Model selection criteria" example that maps to
`modelSelectionCriteria` (so it lists `DIC`, `AIC`, `AICc`, `BIC`, `saBIC`), and
also add a note about the `saveModelHistory` checkbox in the "Using the
Interface" section so the docs consistently recommend enabling model history for
inspecting candidate models when calling `aefa()`.

Comment thread inst/shiny-app/README.md
Comment thread inst/shiny-app/README.md Outdated
Copilot AI review requested due to automatic review settings February 14, 2026 10:45
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

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


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

Comment thread inst/shiny-app/README.md
Comment thread inst/shiny-app/README.md
Comment thread inst/shiny-app/README.md
coderabbitai[bot]
coderabbitai Bot previously requested changes Feb 14, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@inst/shiny-app/README.md`:
- Around line 70-72: The README claims missing-value handling follows a
user-selected policy but there is no UI control or parameter to set this; update
the Shiny app and API: add a missing-value policy input in the UI (app.R) —
e.g., a radio/select input for policies like "remove (na.rm=TRUE)", "impute
mean", "flag error" — propagate that input to server-side validation and pass it
into aefa() (or add a new aefa(missing_policy=...) parameter) so server logic
validates CSV schema/types, applies the chosen policy to handle NAs before
calling aefa(), or alternatively edit the README text to explicitly state that
aefa() currently uses a fixed na.rm=TRUE default if you do not want to change
code.

Comment thread inst/shiny-app/README.md Outdated
coderabbitai[bot]
coderabbitai Bot previously requested changes Feb 14, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@inst/shiny-app/README.md`:
- Line 66: 문구 "file upload control and data preview controls"가 모호하므로 README의 해당
문장을 수정해 명확히 하세요: 데이터 미리보기가 선택적이면 "optionally, data preview controls"로 변경하거나 필수이면
구체적으로 어떤 UI 요소인지(예: "data table display for uploaded CSV" 또는 "preview pane
showing first N rows")로 명시하거나 필요 없다면 문장에서 제거하세요; 변경 대상은 README의 해당 문구와 동일한 문장이고
관련 문맥은 "Using the Interface" 섹션(초반 설명)과 일관되게 업데이트해야 합니다.
- Around line 70-74: Update the README guidance so server-side validation before
calling aefa() lists concrete checks: verify CSV column names and types (e.g.,
all item columns are numeric), confirm item-response ranges (e.g., values within
1–5 or configurable), detect and count missing values (NA/empty cells) and
surface a clear warning message with counts, and validate expected item-response
layout (rows=respondents, columns=items); state that missing-value handling will
follow aefa() defaults unless the app author adds a custom missing-value policy
control in their Shiny server logic.

Comment thread inst/shiny-app/README.md Outdated
Comment thread inst/shiny-app/README.md Outdated
Copilot AI review requested due to automatic review settings February 14, 2026 11:42
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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


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

Comment thread inst/shiny-app/README.md
@seonghobae
Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 14, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@seonghobae seonghobae dismissed stale reviews from coderabbitai[bot], coderabbitai[bot], and coderabbitai[bot] February 14, 2026 11:58

Superseded by latest documentation updates and resolved threads.

@seonghobae seonghobae merged commit e256e81 into develop Feb 14, 2026
15 checks passed
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.

Document minimal Shiny UI configuration for advanced models

2 participants