Encapsulating Elements of Experimental Design

[Up] [Top]

Documentation for package ‘edibble’ version 1.1.1

Help Pages

A C D E F G I L M N O P R S T U W

edibble-package edibble: Encapsulating Elements of Experimental Design

-- A --

activate_provenance Activate the provenance in the edibble design object
allot_table Allot treatments to units and serve table
allot_trts Define allotment of treatments to units
allot_units Define allotment of units to nested units
as.character.edbl_fct Utility functions for edibble variable
as.data.frame.edbl_table Convert edibble table to normal data frame
as.integer.edbl_fct Utility functions for edibble variable
assign_fcts Assign treatments or units to units
assign_trts Assign treatments or units to units
assign_units Assign treatments or units to units
as_edibble An edibble table constructor
as_tibble.edbl_table Convert an edibble data frame to normal data frame
autofill_rcrds Autofill the records

-- C --

column Select a column.
conditioned_on Specify the nesting or conditional structure for units or treatments
count_by Split or count the data according to certain factors
crossed_by Specify the units to cross to index a new unit

-- D --

design Start the edibble design
design-helpers Test and get edibble objects
design_anatomy Anatomy of the design
design_data Get the node or edge data from an edibble design
design_model A baseline model for given experimental design

-- E --

edbl_design Test and get edibble objects
edbl_table Test and get edibble objects
edibble edibble: Encapsulating Elements of Experimental Design
examine_process Examine the simulation process
examine_process_values Examine the simulation process
examine_recipe Check the recipe code
expect-vars Expected type of data entry
expect_rcrds Set the expected values for recording variables
export_design Export the design to xlsx

-- F --

fct Setting the traits of factors
fct_attrs Setting the traits of factors
fct_edges Get the node or edge data from an edibble design
fct_generator Factor name generator
fct_graph Factor graph
fct_nodes Get the node or edge data from an edibble design
formatting Print intermediate experimental design to terminal

-- G --

graph_input A function to process input as input for graph manipulation

-- I --

index_levels Label with nested or distinct labels
is_cross_levels Test and get edibble objects
is_edibble Test and get edibble objects
is_edibble_design Test and get edibble objects
is_edibble_graph Test and get edibble objects
is_edibble_levels Test and get edibble objects
is_edibble_table Test and get edibble objects
is_fct Utility functions for edibble variable
is_named_design Test and get edibble objects
is_nest_levels Test and get edibble objects
is_provenance Check if an object is an instance of the "Provenance" class.
is_rcrd Utility functions for edibble variable
is_takeout A function to check if the output is a takeout design
is_trt Utility functions for edibble variable
is_unit Utility functions for edibble variable

-- L --

label_distinct Label with nested or distinct labels
label_nested Label with nested or distinct labels
label_seq Generate a sequence of labels with custom formatting options
label_seq_from_length Generate a sequence of labels with custom formatting options
label_seq_from_to Generate a sequence of labels with custom formatting options
label_seq_length Generate a sequence of labels with custom formatting options
label_seq_to_length Generate a sequence of labels with custom formatting options
lady_tasting_tea Lady tasting tea
latin Latin square designs and its generalisations as an array
latin_array Latin square designs and its generalisations as an array
latin_rectangle Latin square designs and its generalisations as an array
latin_square Latin square designs and its generalisations as an array
lvls Setting the traits of the levels
lvl_edges Get the node or edge data from an edibble design
lvl_nodes Get the node or edge data from an edibble design

-- M --

menu_bibd Balance incomplete block design
menu_crd Completely randomised design
menu_factorial Prepare a factorial design
menu_graeco Graeco-Latin Square Design
menu_hyper_graeco Hyper-Graeco-Latin Square Design
menu_lsd Prepare classical Latin square design
menu_rcbd Prepare a randomised complete block design
menu_split Split-unit design
menu_strip Strip-unit design
menu_youden Youden square design

-- N --

nested_in Specify the nesting or conditional structure for units or treatments
nesting_structure Get the nesting structure for the units
new_edibble An edibble table constructor

-- O --

order_trts A custom ordering algorithm

-- P --

plot.edbl_design Interactive plot of the edibble design
plot.edbl_table Interactive plot of the edibble design
plot_fct_graph Interactive plot of the edibble design
plot_lvl_graph Interactive plot of the edibble design
print.edbl_design Print intermediate experimental design to terminal
Provenance An object to query, record and modify an edibble graph

-- R --

redesign Start the edibble design
rescale_values Rescale a numerical vector

-- S --

scan_menu Find the short names of the named designs
serve_table Serve edibble table
set_attrs Set the experimental context as metadata
set_rcrds Set records for given unit
set_rcrds_of Set records for given unit
set_trts Set the treatment variables
set_units Set units used in experiment
simulate_process Simulation process
simulate_rcrds Simulate records
skittles Skittles experiment
split_by Split or count the data according to certain factors

-- T --

takeout Create a named experimental design
to_be_character Expected type of data entry
to_be_date Expected type of data entry
to_be_factor Expected type of data entry
to_be_integer Expected type of data entry
to_be_numeric Expected type of data entry
to_be_time Expected type of data entry
trts_table Treatments table

-- U --

utility-edibble-var Utility functions for edibble variable

-- W --

with_params This is a helper function to set the parameter values
with_value Validation values
with_variables A helper function to set variables that the record is dependent on.