rita_analysis: Retained Rita Analysis Metadata

rita_analysisR Documentation

Retained Rita Analysis Metadata

Description

Structured records retained by Rita and precision metadata supplied by its test wrappers.

Details

The additive rita_analysis attribute is present on every successful Rita() call. Its schema_version is integer 1. All indices are one-based. No S3 class is added. The first two positional return elements keep their existing meanings.

settings contains canonical test and transformation names, alpha, j, threshold, seed, return_transformed, plotting flags, and active SW/KSL options. Inactive SW or KSL settings are NULL. A NULL seed means the caller's RNG stream was used; no copy of the caller's full RNG state is retained.

cleaning contains input_rows, input_columns, final_rows, final_columns, retained_columns (original positions), retained_rows and omitted_rows (original row positions). Its variables data frame has one row per original input column: original_position, variable, missing_original, missing_coercion, missing_total, considered_for_complete_cases, exclusion_stage, exclusion_reason and retained. Missingness fields are counts, not observation-level masks. Exclusion stages are before-complete-cases or after-complete-cases, with NA for retained variables. The considered_for_complete_cases flag separates early-excluded missingness from missingness relevant to the actual row filter. Counts include NA and NaN. Metadata records the executed cleaning sequence. Later exclusions never recover rows and do not alter the common complete-case sample.

descriptives contains scale (original-cleaned), values (an unrounded data frame with statistics in rows and retained variables in columns), skewness and kurtosis convention labels. Undefined small-sample moments remain undefined.

selection is a list in retained-variable order. Each record contains original_position, variable, method (canonical transformation), mode (requested or automatic), criterion, score, candidates, tied_methods and tie_resolution. Automatic candidates is an ordered data frame of method and score. All exact maxima are listed in tied_methods; the first is selected. tie_resolution is unique-maximum or first-exact-maximum. Requested transformations have NULL candidates, empty tied_methods and not-applicable tie_resolution. Their score is still the already-computed QQ correlation squared. Scores use the full cleaned data and the existing candidate order and formula.

tests is a list in retained-variable order; each element is a named list of the requested canonical tests, with the same structure in single- and all-tests mode. Each test record contains original_position, variable, transformation, test, statistic_name, statistic, p.value, precision, usable_n, tested_n, alpha, j, threshold, significant, decision, status, reason, calibration, calibration_details, monte_carlo, sampling, warnings, limitations and result. The result field is the actual wrapper result, including its attributes, also used by the pre-existing normality_tests attribute where that attribute applies. Descriptive list names may repeat if input names repeat; original_position is the unambiguous identity.

statistic and p.value use the computed unrounded values supplied by rita_test. precision is unrounded-computation for usable numerical results and unavailable otherwise. decision is reject, do not reject, or unavailable. significant is NA when inference is unavailable. The raw legacy flag is in result[[3]] when present. Usable n describes the common cleaned sample. Tested n records the actual sample used for attempted computations, including failures and SW subsets. It is zero when the test did not run. No test is rerun to construct these fields.

status is computed, monte-carlo-floor (zero exceedances), approximation-boundary (clipped Molin-Abdi output), numerical-zero, invalid-numerical-result, or unavailable. A numerical zero may reflect underflow. An attempted numerical failure has status invalid-numerical-result and an informative reason. The original statistic and p.value remain available for diagnosis. The main console table masks invalid values and shows the decision as unavailable. Failure to reject does not establish normality. Nominal probabilities do not account for fitting or selecting a transformation on the same data.

calibration identifies stats-shapiro-wilk, molin-abdi, normal-null-monte-carlo, stephens-1986, chi-square-2, pearson-chi-square-approximation, or not-computed. calibration_details includes the raw Molin-Abdi probability and clipped flag, chi-square df where applicable, and Pearson cell count and expected frequency. monte_carlo retains the wrapper's existing replicate counts, exceedances, resolution and any available interval or other metadata; it is NULL for non-simulation methods. The plus-one resolution floor is not a bound on the true tail probability. sampling retains SW metadata with indices mapped to original rows, original_n describing the original input size, and complete_case_indices mapped to the cleaned sample. The nested result keeps the wrapper's original coordinate convention unchanged.

warnings records warning messages emitted during that individual test call without suppressing them. Global Rita warnings, such as shared subsampling, are not duplicated here. limitations separately records applicable qualifications, including subsampling, approximate calibration and small-sample restrictions. Existing method-specific numerical and calibration limitations remain.

The wrapper attribute rita_test contains statistic, p.value, n_tested, precision, calibration, details, status, reason and decision. The metadata decision is unavailable when the raw result is invalid. The legacy list elements keep their original rounding and flags. Small-sample sentinels may lack this attribute. A numerical zero or one alone does not establish an exact tail probability or approximation clipping.

See Also

Rita


Rita documentation built on Nov. 14, 2026, 1:07 a.m.

Related to rita_analysis in Rita...