layouts_to_instructions: The one-shot function to convert layouts into an echo...

Description Usage Arguments Value

View source: R/layouts_to_instructions.R

Description

The one-shot function to convert layouts into an echo instructions file, and save the associated fodler

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
layouts_to_instructions(
  expnum,
  save_path = "",
  daughter_path,
  mother_path,
  save_output = FALSE,
  .well_col_daughter = "well",
  .compound_col_daughter = "compound",
  .concentration_col_daughter = "concentration",
  .volume_col_daughter = "volume",
  .well_col_mother = "well",
  .compound_col_mother = "compound",
  .concentration_col_mother = "concentration",
  .if_missing = "stop",
  .if_varied = "stop",
  .if_impossible = "stop",
  .echo_drop_vol = 25,
  .max_mother_pull = 35
)

Arguments

expnum

The experiment number, e.g. "4242"

save_path

the path to save the instructions folder in

daughter_path

path to the daughter layout

mother_path

to the mother layout

save_output

if TRUE, saves the resulting instructions in the save_path

.well_col_daughter

passed to standardize_layouts for daughter. Defaults to "well".

.compound_col_daughter

passed to standardize_layouts for daughter. Defaults to "compound".

.concentration_col_daughter

passed to standardize_layouts for daughter. Defaults to "concentration".

.volume_col_daughter

passed to standardize_layouts for daughter. Defaults to "volume".

.well_col_mother

passed to standardize_layouts for mother. Defaults to "well".

.compound_col_mother

passed to standardize_layouts for mother. Defaults to "compound".

.concentration_col_mother

passed to standardize_layouts for mother. Defaults to "concentration".

.if_missing

action to take if compounds in the daughter are not in the mother. Defaults to "stop". Passed to repair_layout.

.if_varied

action to take if ccompounds are present at multile concentrations in the mother. Defaults to "stop". Passed to repair_layout.

.if_impossible

action to take if compounds are present in the daughter at concentrations greater than the mother can provide. Defaults to "stop". Passed to repair_layout.

.echo_drop_vol

the volume of the droplet for the echo instrument to be used. Defaults to 25.

.max_mother_pull

the maximum volume to be pulled from any one well in the mother. If exceeded, this will be noted in the the final plateview plots, and transfer csv. Defaults to 35.

Value

a list containing all intermediate and final objects. If save_output = TRUE, also saves the echo instrutions in a folder.


taiawu/echowritr documentation built on Dec. 23, 2021, 7:42 a.m.