stats_table: Generate table of possible statistics to test

Description Usage Arguments Value Details Additional notes Author(s)

View source: R/stats_table.R

Description

To use get_stats we need a set of statistics to test. We also require their codes (to look up in the Distance for Windows database) and their equivalent values in mrds (or how to calculate those values). This function provides such a table.

Usage

1
stats_table(engine = "CDS")

Arguments

engine

which engine do we need to compute stats for?

Value

a data.frame with statistics Distance for Windows collects that have equivalents in mrds. The data.frame has three columns: Code, the numeric code for the statistic (as used in the Distance for Windows database); Name, the short name for this statistic; MRDS, the operation required to obtain the equivalent statistic in mrds; Description, a short description of the statistic.

Details

Data for this table (numeric code and descriptions) is from the DistIni.mdb which is shipped with Distance for Windows. See also https://github.com/distancedevelopment/readdst/wiki/distance-results-codes.

Additional notes

Note that the Cramer-von Mises p-value as recorded in Distance for Windows is only recorded to the nearest 0.1.

Author(s)

David L Miller


DistanceDevelopment/readdst documentation built on Sept. 21, 2021, 10:41 p.m.