Skip to contents

sframe_apa() returns the APA-formatted sentence a result carries. sframe_flagged() returns the rows a quality report flagged.

Value

sframe_apa() returns a character vector: one element per block, named by block, for analysis results, and one element for a single report. sframe_flagged() returns an integer vector of row positions, sorted, each row once.

Details

Given analysis results, sframe_apa() answers for every block at once, as a character vector named by block. Given one of the standalone reports that carry a sentence of their own, an assumption report, a descriptives report, a missing-data report or a validity report, it returns that single sentence. A result lacking a sentence gives an empty string, so the shape of the answer follows the number of blocks asked about.

The sentence is plain text. APA 7 asks for italic Latin statistical symbols, so italicise t, F, p, r, d and the remaining Latin statistical symbols after pasting into a manuscript. Numbers are already APA-formatted, including the APA 7 form .032 for p and a labelled confidence interval.

sframe_flagged() returns row positions in the response data, as one sorted vector with each row once, pooling every check the quality report ran: failed attention checks, straight-lining, excess missingness, timing and duplicates. Read the report itself for which check flagged a row.

Examples

demo <- sframe_demo("tourism_services")
qr <- sframe_quality_results(demo$responses, demo$instrument)
head(sframe_flagged(qr))