Changelog • speed

speed 0.0.10

Added a summary() method for "design" objects, reporting structure and replication, a decomposed optimisation score, and design-quality diagnostics. (#73)
grid_factors gains an optional by element naming the column that separates a design into several grids, e.g. list(dim1 = "row", dim2 = "col", by = "site") for a multi-environment trial. Each grid is scored on its own.

Designs whose row/col columns are not numeric, or where two plots share a coordinate, now fail with a message naming the problem.

Design metrics are now built from each plot’s row/col coordinates rather than the order of the rows in the data frame. Designs generated with objective_function_piepho() should be regenerated.
Multi-site designs are no longer scored as one pooled grid, which discarded plots whose coordinates collided and counted adjacencies between sites. Use grid_factors$by to name the grouping column.
objective_function_piepho() now scores evenness of distribution per grid and reports each grid separately. A grid with no treatment replicated within it contributes 0 rather than Inf.
calculate_efficiency_factor() now errors for a design whose treatment contrasts are not estimable, instead of returning an impossible value above 1. The row-column model gained an intercept, which does not change results that were already valid.
summary() no longer errors on designs that cannot be placed on a single grid; the affected diagnostics report why they are unavailable instead.
calculate_nb() no longer errors on designs with missing plots when pair_mapping is not supplied.
calculate_adjacency_score() now recycles a single ring_weights value across every entry of ring_dists, so the default is usable with more than one ring.
swap_all = TRUE no longer changes the replication of a design when an earlier level has unbalanced a swap group mid-search. Only treatments with matching replication are exchanged.

Deprecated the splits argument of initialise_design_df() in favor of initialise_split_design_df(). Passing splits now warns with the equivalent suggested call.

speed() now errors when swap_all = TRUE is used on a design with unequal within-group replication, instead of silently swapping treatments with different replication counts.
speed() no longer returns numeric/integer columns (e.g. treatment, row, col) as their internal factor level codes instead of their original values.
speed() no longer emits a “Setting row names on a tibble is deprecated” warning when passed a tibble.
speed() now accepts designs with vctrs-backed multi-class columns (e.g. from the edibble package) instead of erroring; such columns are now returned as character.

Added ring_dists, ring_weights, and ring_type arguments to calculate_adjacency_score for weighting matches at larger adjacent ring radii; can be passed via speed().

Added splits argument to initialise_design_df to support split-plot designs (#92).
Added main_weight and interaction_weight arguments to objective_function_factorial to tune the trade-off between main-treatment and interaction balance (#90).

Fixed autoplot.design where 'block' column was required when providing another column for block (#88).

Extended random_initialise to handle hierarchical (multi-level) optimise lists by shuffling within each level’s grouping.

Added objective_function_factorial for factorial designs, combining main-treatment and interaction balance scores (#78).

Optimisation parameters were changed from options to arguments to enable better reproducibility of designs (#65
Enabled one stage MET designs
Added contributing guide and code of conduct (#59)

See changelog for further details.

Enabled more complex designs and added some vignettes with examples and detailed use.

See changelog for further details.

First version.