-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add DeepWiki entry point and Pages-ready product guide #319
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # aFIPC | ||
|
|
||
| Automated Fixed Item Parameter Calibration for item-response-theory linking and equating. | ||
|
|
||
| ## Product responsibility | ||
|
|
||
| aFIPC preserves a common measurement scale across test forms by combining anchor-item parameters from a reference form with calibration of newly administered items. It is intended for psychometric workflows where score comparability across administrations matters and fixed-item linking is the chosen design. | ||
|
|
||
| ## Core workflow | ||
|
|
||
| 1. Prepare reference-form and new-form response data with a stable set of common items. | ||
| 2. Fit or supply the reference-form item parameters used as linking anchors. | ||
| 3. Run `autoFIPC()` to construct the fixed-item calibration workflow for the new form. | ||
| 4. Review model diagnostics and linking outputs before downstream score reporting or operational use. | ||
|
|
||
| ## Architecture | ||
|
|
||
| The repository is an R package with a focused calibration core: | ||
|
|
||
| - `R/aFIPC.R` contains the main fixed-item linking workflow. | ||
| - `R/surveyFA.R` contains supporting analytical routines used by the package. | ||
| - `DESCRIPTION`, `NAMESPACE`, and `man/` define package metadata and generated reference documentation. | ||
| - `ARCHITECTURE.md` documents structural boundaries and maintenance constraints. | ||
| - `.github/workflows/` provides continuous-integration and security checks. | ||
|
|
||
| The package keeps established numerical behavior as a compatibility constraint; behavioral changes should be supported by regression evidence rather than incidental refactoring. | ||
|
|
||
| ## Onboarding | ||
|
|
||
| Clone the repository, use a current R toolchain, and run the package checks before changing calibration behavior: | ||
|
|
||
| ```bash | ||
| R_PROFILE_USER=/dev/null Rscript -e \ | ||
| 'install.packages(c("rcmdcheck"), repos="https://cloud.r-project.org")' | ||
| R_PROFILE_USER=/dev/null Rscript -e \ | ||
| 'rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning")' | ||
| ``` | ||
|
|
||
| For contributor expectations and architectural context, read `CONTRIBUTING.md` and `ARCHITECTURE.md` before modifying estimation or linking logic. | ||
|
|
||
| ## Releases and change control | ||
|
|
||
| The repository currently does not publish GitHub Releases. Until a tagged release is available, consumers should pin an explicitly tested commit or package build and review the repository history for behavioral changes. Calibration changes should preserve reproducibility and be accompanied by test evidence. | ||
|
|
||
| ## Documentation and support | ||
|
|
||
| - Repository README: concise product and contributor entry point. | ||
| - `ARCHITECTURE.md`: package boundaries and design context. | ||
| - `man/`: generated R reference documentation. | ||
| - [Ask DeepWiki](https://deepwiki.com/ContextualWisdomLab/aFIPC): repository-aware documentation and code navigation. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Markdown lint blocks the pull request
The new prose exceeds the configured line limit, so
markdownlint-cli2reports 11 violations. The required Code Quality check fails.Prompt for agents
Was this helpful? React with 👍 or 👎 to provide feedback.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed on current branch after the public-surface and licensing expansion: README.md and docs/index.md prose are wrapped to the repository's 80-character Markdown line-length contract. The only intentionally long lines are URL/code forms that markdownlint treats under its configured exceptions. Exact-head checks must regenerate on the new head; predecessor review/check evidence is not reused.