Skip to content

TESTING_DOCUMENTATION.md

Latest commit

 

History

History
102 lines (73 loc) · 3.02 KB

TESTING_DOCUMENTATION.md

File metadata and controls

102 lines (73 loc) · 3.02 KB
Raw

Comprehensive Testing Documentation for kaefa Package

Executive Summary

This document provides a complete overview of the test suite created for the kaefa R package to validate spelling corrections and documentation improvements in the current commit.

Changes Being Tested

1. DESCRIPTION File Changes

  • Line 19: Corrected typo "pallelise" → "parallelised" (British English)
  • Line 27: Added "Language: en-GB" to specify British English

2. New File Added

  • inst/WORDLIST: New file containing 90 technical terms for spell checking
    • Supports the spelling R package
    • Whitelists domain-specific terminology to prevent false positives

3. Documentation (.Rd) File Corrections

Spelling corrections across 6 man files:

man/aefa.Rd (6 corrections)

  • historys → histories
  • critera → criteria
  • messeages → messages
  • avaliable → available
  • (saveModelHistory description updated)
  • (modelSelectionCriteria description updated)

man/aefaInit.Rd (4 corrections)

  • Initalize → Initialise
  • initalise → initialises
  • informaiton → information
  • Speicfy → Specify

man/engineAEFA.Rd (3 corrections)

  • combinating → combining
  • messeages → messages
  • avaliable → available

man/evaluateItemFit.Rd (1 correction)

  • critera → criteria

man/kaefa.Rd (3 corrections)

  • resarch → research
  • statistcal → statistical
  • pallelise → parallelised

man/recursiveFormula.Rd (1 correction)

  • devide → divide

Total: 18 spelling corrections

Test Suite Architecture

Test Files Created

The test suite is organized into the following files (see tests/TEST_SUMMARY.md for details):

File Purpose
tests/testthat/test-wordlist.R WORDLIST format and content validation
tests/testthat/test-description.R DESCRIPTION file integrity and spelling checks
tests/testthat/test-documentation.R Documentation spelling and quality checks
tests/testthat/test-spelling-comprehensive.R Comprehensive spelling validation
tests/testthat/test-wordlist-integrity.R Additional WORDLIST edge cases
tests/testthat/test-validation-comprehensive.R Meta-validation of test effectiveness

Running the Tests

Run the full test suite:

library(testthat)
library(kaefa)
test_check("kaefa")

Run a specific test file:

test_file("tests/testthat/test-wordlist.R")

Run with devtools (optional):

devtools::test()

Expected Results and Pass Criteria

  • All tests should pass without failures.
  • If the WORDLIST or documentation directories are missing in the installed package, related tests will be skipped with explicit messages.
  • Spelling corrections listed above should remain enforced, and documentation should remain consistent with en-GB spelling.

Dependencies and References

  • testthat (>= 2.0.0)
  • tools (for Rd parsing and documentation checks)
  • devtools is optional for running devtools::test()

Reference: tests/TEST_SUMMARY.md contains the detailed test breakdown and spelling correction inventory.