Skip to content

scrutiny 0.4.0

Compare
Choose a tag to compare
@lhdjung lhdjung released this 23 Feb 23:41

This version brings major performance improvements. Furthermore:

Bugfixes

  • Fixed a bug in audit_seq(): If the dispersion argument in the preceding call to a function like grim_map_seq() was specified as something other than a linearly increasing sequence, the "diff_*" columns in the data frames returned by audit_seq() may have contained incorrect values.
  • Similarly, audit_seq() and reverse_map_seq() used to reconstruct the reported values incorrectly if the dispersion default was overridden as described above. At least for now, the issue is handled by throwing an error if these functions operate on data frames that are the result of specifying dispersion as something other than a linearly increasing sequence.
  • Fixed a bug that incorrectly threw an error in grim_map_seq(), other functions made by function_map_seq(), as well as seq_disperse() and seq_disperse_df() if an input value was so close to out_min or out_max that the output sequence would be shorter than implied by dispersion / .dispersion , and if track_var_change / .track_var_change (see below) was TRUE. Again, note that the bug only occurred if an error was thrown.

New features

  • A new vignette lists the options for specifying the rounding argument that many scrutiny functions have: vignette("rounding-options").
  • Another new vignette shows the minimal steps to implement a consistency test using scrutiny: vignette("consistency-tests-simple").
  • The output of grim_map_seq(), grimmer_map_seq(), debit_map_seq() and any other function made by function_map_seq() now has a diff_var column that tracks the difference between the dispersed variable (see the var column) and the reported value. Following the diff_* columns in the output of audit_seq(), this is the number of dispersion steps, not the actual numeric difference.
  • The same diff_* columns are now integer, not double.
  • function_map(), function_map_seq(), and function_map_total_n() have a new .name_key_result argument that controls the name of the key result column in the output of the factory-made function. This is "consistency" by default, but other names will fit better for other kinds of tests. (The results of these tests must still be logical values.)

Minor changes

  • In duplicate_count(), the count column in the output tibble was renamed to frequency. This makes for a more streamlined frequency table and removes an ambiguity with duplicate_count_colpair(), where the count output column means something different.
  • In seq_disperse() and seq_disperse_df(), the track_var_change / .track_var_change argument was renamed to track_diff_var / .track_diff_var. The arguments with the old names are still present for now but will be removed in a future version. Also, the unit of these values is now dispersion steps, for consistency with grim_map_seq() etc. as well as audit_seq().
  • grim_total(), grim_ratio(), and grim_ratio_upper() now require x to have length 1.
  • The docs now link to functions when opened in RStudio, not just on the website.
  • Accordingly, the output of write_doc_factory_map_conventions() now renders links. The function also has a new scrutiny_prefix argument for use in another package.
  • The "Infrastructure" article was renamed to "Developer tools"; vignette("devtools").
  • Some dependencies that used to be suggested are now imported.