Use named arguments when writing FielDHub scripts. The common names below describe the same concepts across the design families that support them. Each function's help page defines its supported inputs and constraints.
Common arguments
tTreatments in classical designs: a count or, where supported, a vector of labels. Check-based designs use
linesfor the number of experimental entries excluding checks.repsFull replicates per location in classical, incomplete-block, lattice, row-column and strip-plot designs. In
latin_square(), this is the number of independent squares. Partial and multi-location replication uses the design-specific allocation arguments instead.lNumber of locations.
CRD()andlatin_square()generate one location and have nolargument.locationNamesLocation labels, in location order.
CRD()takes one location name.plotNumberStarting plot number, or one start per location.
seedSeed recorded in the result to reproduce randomization. When
seedisNULL, one integer is drawn from the current random-number stream and recorded; the design's own randomization does not change the caller's stream.kNumber of plots per incomplete block.
checksA check count, entry identifiers, or labels; see "Dimensions, factors and checks" below.
rep_checksCheck replication: how many times each check is repeated.
RCBD()takes one count per check label supplied inchecks(recycled from a scalar).optimized_arrangement()takes either a total check count or one count per check label (this isamountChecksin 1.5.x scripts; see "Migrating existing scripts"). Multi-location allocations (multi_location_prep(),do_optim(design = "prep")) take the same one-count-per-check form.sparse_allocation()anddo_optim(design = "sparse")have norep_checks: every check is replicated once per location by construction.
Dimensions, factors and checks
nrows and ncols describe field dimensions in spatial designs.
In row_column(), nrows is the number of rows per replicate;
field_layout() controls how replicates are placed in the field.
Factorial, split-plot and strip-plot designs keep their factor-specific
arguments so whole plots, subplots and crossed strips remain distinct.
The meaning of checks is design-specific: a count, entry identifiers,
or labels. Consult the function's help before transferring a check vector
between design families.
Partial and multi-location replication does not share one argument name
across families; each keeps the allocation arguments that describe its own
replication scheme: partially_replicated()'s repGens (how
many entries get each replication level) and repUnits (those
replication levels), and RCBD_augmented()'s b (number of
augmented blocks) and repsExpt (replicates of the whole experiment).
These are design-specific allocation arguments, not aliases of
reps or rep_checks.
Boolean controls
Logical switches such as continuous, factorLabels,
spread_reps, allow_fillers, and randomizeH require one
nonmissing TRUE or FALSE. Numeric switches (0/1),
strings, vectors, and arrays are not supported. Invalid switches signal a
fieldhub_input_error before randomization, with argument,
value, and options fields identifying the correction.
Migrating existing scripts
CRD(locationName = ...) remains supported; use
CRD(locationNames = ...) in new code. In incomplete_blocks(),
alpha_lattice(), square_lattice(), rectangular_lattice()
and row_column(), replace the argument name r with reps.
In strip_plot(), replace b with reps.
In optimized_arrangement(), replace amountChecks with
rep_checks.
RCBD_augmented(b = ...) still denotes blocks and is unchanged.
Old names and positional calls retain their meaning and signal a warning
of class fieldhub_deprecated_warning. Supplying both names for one
argument is an error, even if their values agree. These aliases do not change
seeded designs or the field names of saved results.