knitr::opts_chunk$set( collapse = TRUE, comment = NA, warning = FALSE, message = FALSE )
This vignette shows how to generate a Alpha Lattice Design using both the FielDHub Shiny App and the scripting function alpha_lattice()
from the FielDHub
package.
To launch the app you need to run either
FielDHub::run_app()
or
library(FielDHub) run_app()
Once the app is running, go to Lattice Designs > Alpha Lattice
Then, follow the following steps where we will show how to generate this kind of design with 55 treatments and 3 reps.
Import entries' list? Choose whether to import a list with entry numbers and names for genotypes or treatments.
If the selection is No
, that means the app is going to generate synthetic data for entries and names of the treatment/genotypes based on the user inputs.
If the selection is Yes
, the entries list must fulfill a specific format and must be a .csv
file. The file must have the columns ENTRY
and NAME
. The ENTRY
column must have a unique entry integer number for each treatment. The column NAME
must have a unique name that identifies each treatment. Both ENTRY and NAME must be unique, duplicates are not allowed. In the following table, we show an example of the entries list format. This example has an entry list with 12 treatments.
ENTRY <- 1:12 NAME <- c(paste0("Genotype", LETTERS[1:12])) df <- data.frame(ENTRY,NAME)
library(knitr) kable(df)
Input the number of treatments in the Input # of Treatments box. In the alpha lattice design, the number of treatments must be a composite number. In this case, set it to 55
.
Select the number of replications of these treatments with the Input # of Full Reps box. Set it to 3
.
Set the number of plots in each incomplete block in the Input # of Plots per IBlock box. Set it to 5
.
Enter the number of locations in Input # of Locations. We will run this experiment over a single location, so set it to 1
.
Select serpentine
or cartesian
in the Plot Order Layout. For this example we will use the default cartesian
layout.
Enter the starting plot number in the Starting Plot Number box. If the experiment has multiple locations, you must enter a comma separated list of numbers the length of the number of locations for the input to be valid. Set it to 101
.
Enter a name for the location of the experiment in the Input Location box. If there are multiple locations, each name must be in a comma separated list. For this example, set it to "FARGO"
.
To ensure that randomizations are consistent across sessions, we can set a random seed in the box labeled random seed. In this example, we will set it to 1235
.
Once we have entered the information for our experiment on the left side panel, click the Run! button to run the design.
After you run an alpha lattice design in FielDHub, there are several ways to display the information contained in the field book.
When you first click the run button on an alpha lattice design, FielDHub displays the Field Layout tab, which shows the entries and their arrangement in the field. In the box below the display, you can change the layout of the field or change the location displayed.
You can also display a heatmap over the field by changing Type of Plot to Heatmap
. To view a heatmap, you must first simulate an experiment over the described field with the Simulate! button. A pop-up window will appear where you can enter what variable you want to simulate along with minimum and maximum values.
The Field Book displays all the information on the experimental design in a table format. It contains the specific plot number and the row and column address of each entry, as well as the corresponding treatment on that plot. This table is searchable, and we can filter the data in relevant columns. If we have simulated data for a heatmap, an additional column for that variable appears in the Field Book.
FielDHub
function: alpha_lattice()
You can run the same design with a function in the FielDHub package, alpha_lattice()
.
First, you need to load the FielDHub
package typing,
library(FielDHub)
Then, you can enter the information describing the above design like this:
alpha <- alpha_lattice( t = 55, r = 3, k = 5, l = 1, plotNumber = 101, locationNames = "FARGO", seed = 1235 )
alpha_lattice()
aboveThe description for the inputs that we used to generate the design,
t = 55
is the number of treatments.r=3
is the number of replicates.k = 5
is the number of plots per incomplete block.l = 1
is the number of locations.plotNumber = 101
is the starting plot number.locationNames = "FARGO"
is an optional name for each location.seed = 1235
is the random seed to replicate identical randomizations.alpha
objectTo print a summary of the information that is in the object alpha
, we can use the generic function print()
.
print(alpha)
print(alpha)
alpha
objectThe function alpha_lattice()
returns a list consisting of all the information displayed in the output tabs in the FielDHub app: design information, plot layout, plot numbering, entries list, and field book. These are accessible by the $
operator, i.e. alpha$layoutRandom
or alpha$fieldBook
.
alpha$fieldBook
is a list containing information about every plot in the field, with information about the location of the plot and the treatment in each plot. As seen in the output below, the field book has columns for ID
, LOCATION
, PLOT
, REP
, IBLOCK
, UNIT
, ENTRY
, and TREATMENT
.
field_book <- alpha$fieldBook head(alpha$fieldBook, 10)
field_book <- alpha$fieldBook head(alpha$fieldBook, 10)
For plotting the layout in function of the coordinates ROW
and COLUMN
, you can use the the generic function plot()
as follows,
plot(alpha)
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.