This document gives an overview of the DNABarcodeCompatibility R package with a brief description of the set of tools that it contains. The package includes six main functions that are briefly described below with examples. These functions allow one to load a list of DNA barcodes (such as the Illumina TruSeq small RNA kits), to filter these barcodes according to distance and nucleotide content criteria, to generate sets of compatible barcode combinations out of the filtered barcode list, and finally to generate an optimized selection of barcode combinations for multiplex sequencing experiments. In particular, the package provides an optimizer function to favour the selection of compatible barcode combinations with least heterogeneity in the frequencies of DNA barcodes, and allows one to keep barcodes that are robust against substitution and insertion/deletion errors, thereby facilitating the demultiplexing step.
The DNABarcodeCompatibility package also contains:
experiment_design() allowing one to perform all steps
in one go.IlluminaIndexesRaw and IlluminaIndexes for running
and testing examples.The package deals with the three existing sequencing-by-synthesis chemistries from Illumina:
library("DNABarcodeCompatibility")# This function is created for the purpose of the documentation
export_dataset_to_file =
function(dataset = DNABarcodeCompatibility::IlluminaIndexesRaw) {
if ("data.frame" %in% is(dataset)) {
write.table(dataset,
textfile <- tempfile(),
row.names = FALSE, col.names = FALSE, quote=FALSE)
return(textfile)
} else print(paste("The input dataset isn't a data.frame:",
"NOT exported into file"))
}The function experiment_design() uses a Shannon-entropy maximization approach
to identify a set of compatible barcode combinations in which the frequencies
of occurrences of the various DNA barcodes are as uniform as possible.
The optimization can be performed in the contexts of single and dual barcoding.
It performs either an exhaustive or a random search of compatible DNA-barcode
combinations, depending on the size of the DNA-barcode set used, and on the
number of samples to be multiplexed.
txtfile <- export_dataset_to_file (
dataset = DNABarcodeCompatibility::IlluminaIndexesRaw
)
experiment_design(file1=txtfile,
sample_number=12,
mplex_level=3,
platform=4)
## [1] "Theoretical max entropy: 2.48491"
## [1] "Entropy of the optimized set: 2.48491"
## sample Lane Id sequence
## 1 1 1 RPI27 ATTCCT
## 2 2 1 RPI29 CAACTA
## 3 3 1 RPI42 TAATCG
## 4 4 2 RPI03 TTAGGC
## 5 5 2 RPI22 CGTACG
## 6 6 2 RPI28 CAAAAG
## 7 7 3 RPI06 GCCAAT
## 8 8 3 RPI12 CTTGTA
## 9 9 3 RPI20 GTGGCC
## 10 10 4 RPI02 CGATGT
## 11 11 4 RPI09 GATCAG
## 12 12 4 RPI41 GACGACtxtfile <- export_dataset_to_file (
dataset = DNABarcodeCompatibility::IlluminaIndexesRaw
)
experiment_design(file1=txtfile,
sample_number=12,
mplex_level=3,
platform=2)
## [1] "Theoretical max entropy: 2.48491"
## [1] "Entropy of the optimized set: 2.48491"
## sample Lane Id sequence
## 1 1 1 RPI06 GCCAAT
## 2 2 1 RPI13 AGTCAA
## 3 3 1 RPI33 CAGGCG
## 4 4 2 RPI29 CAACTA
## 5 5 2 RPI43 TACAGC
## 6 6 2 RPI48 TCGGCA
## 7 7 3 RPI08 ACTTGA
## 8 8 3 RPI17 GTAGAG
## 9 9 3 RPI26 ATGAGC
## 10 10 4 RPI05 ACAGTG
## 11 11 4 RPI36 CCAACA
## 12 12 4 RPI42 TAATCGtxtfile <- export_dataset_to_file (
dataset = DNABarcodeCompatibility::IlluminaIndexesRaw
)
experiment_design(file1=txtfile,
sample_number=12,
mplex_level=3,
platform=1)
## [1] "Theoretical max entropy: 2.48491"
## [1] "Entropy of the optimized set: 2.48491"
## sample Lane Id sequence
## 1 1 1 RPI08 ACTTGA
## 2 2 1 RPI34 CATGGC
## 3 3 1 RPI35 CATTTT
## 4 4 2 RPI11 GGCTAC
## 5 5 2 RPI27 ATTCCT
## 6 6 2 RPI33 CAGGCG
## 7 7 3 RPI20 GTGGCC
## 8 8 3 RPI31 CACGAT
## 9 9 3 RPI42 TAATCG
## 10 10 4 RPI07 CAGATC
## 11 11 4 RPI14 AGTTCC
## 12 12 4 RPI38 CTAGCTtxtfile <- export_dataset_to_file (
dataset = DNABarcodeCompatibility::IlluminaIndexesRaw
)
experiment_design(file1=txtfile,
sample_number=12,
mplex_level=3,
platform=4,
metric = "hamming",
d = 3)
## [1] "Theoretical max entropy: 2.48491"
## [1] "Entropy of the optimized set: 2.48491"
## sample Lane Id sequence
## 1 1 1 RPI06 GCCAAT
## 2 2 1 RPI08 ACTTGA
## 3 3 1 RPI17 GTAGAG
## 4 4 2 RPI11 GGCTAC
## 5 5 2 RPI23 GAGTGG
## 6 6 2 RPI40 CTCAGA
## 7 7 3 RPI09 GATCAG
## 8 8 3 RPI13 AGTCAA
## 9 9 3 RPI45 TCATTC
## 10 10 4 RPI07 CAGATC
## 11 11 4 RPI38 CTAGCT
## 12 12 4 RPI46 TCCCGA# Select the first half of barcodes from the dataset
txtfile1 <- export_dataset_to_file (
DNABarcodeCompatibility::IlluminaIndexesRaw[1:24,]
)
# Select the second half of barcodes from the dataset
txtfile2 <- export_dataset_to_file (
DNABarcodeCompatibility::IlluminaIndexesRaw[25:48,]
)
# Get compatibles combinations of least redundant barcodes
experiment_design(file1=txtfile1,
sample_number=12,
mplex_level=3,
platform=4,
file2=txtfile2)
## [1] "Theoretical max entropy: 2.48491"
## [1] "Entropy of the optimized set: 2.48491"
## Id Lane
## 1 RPI05 1
## 2 RPI19 1
## 3 RPI20 1
## 4 RPI06 2
## 5 RPI14 2
## 6 RPI18 2
## 7 RPI02 3
## 8 RPI07 3
## 9 RPI09 3
## 10 RPI04 4
## 11 RPI10 4
## 12 RPI15 4
## [1] "Theoretical max entropy: 2.48491"
## [1] "Entropy of the optimized set: 2.48491"
## Id Lane
## 1 RPI26 1
## 2 RPI38 1
## 3 RPI48 1
## 4 RPI29 2
## 5 RPI39 2
## 6 RPI47 2
## 7 RPI25 3
## 8 RPI37 3
## 9 RPI43 3
## 10 RPI35 4
## 11 RPI40 4
## 12 RPI44 4
## Id Lane sequence
## 1 RPI05 1 ACAGTG
## 2 RPI19 1 GTGAAA
## 3 RPI20 1 GTGGCC
## 4 RPI06 2 GCCAAT
## 5 RPI14 2 AGTTCC
## 6 RPI18 2 GTCCGC
## 7 RPI02 3 CGATGT
## 8 RPI07 3 CAGATC
## 9 RPI09 3 GATCAG
## 10 RPI04 4 TGACCA
## 11 RPI10 4 TAGCTT
## 12 RPI15 4 ATGTCA
## Id Lane sequence
## 1 RPI26 1 ATGAGC
## 2 RPI38 1 CTAGCT
## 3 RPI48 1 TCGGCA
## 4 RPI29 2 CAACTA
## 5 RPI39 2 CTATAC
## 6 RPI47 2 TCGAAG
## 7 RPI25 3 ACTGAT
## 8 RPI37 3 CGGAAT
## 9 RPI43 3 TACAGC
## 10 RPI35 4 CATTTT
## 11 RPI40 4 CTCAGA
## 12 RPI44 4 TATAAT
## sample Lane Id1 sequence1 Id2 sequence2
## 1 1 1 RPI05 ACAGTG RPI26 ATGAGC
## 2 2 1 RPI19 GTGAAA RPI38 CTAGCT
## 3 3 1 RPI20 GTGGCC RPI48 TCGGCA
## 4 4 2 RPI06 GCCAAT RPI29 CAACTA
## 5 5 2 RPI14 AGTTCC RPI39 CTATAC
## 6 6 2 RPI18 GTCCGC RPI47 TCGAAG
## 7 7 3 RPI02 CGATGT RPI25 ACTGAT
## 8 8 3 RPI07 CAGATC RPI37 CGGAAT
## 9 9 3 RPI09 GATCAG RPI43 TACAGC
## 10 10 4 RPI04 TGACCA RPI35 CATTTT
## 11 11 4 RPI10 TAGCTT RPI40 CTCAGA
## 12 12 4 RPI15 ATGTCA RPI44 TATAAT# Select the first half of barcodes from the dataset
txtfile1 <- export_dataset_to_file (
DNABarcodeCompatibility::IlluminaIndexesRaw[1:24,]
)
# Select the second half of barcodes from the dataset
txtfile2 <- export_dataset_to_file (
DNABarcodeCompatibility::IlluminaIndexesRaw[25:48,]
)
# Get compatibles combinations of least redundant barcodes
experiment_design(file1=txtfile1, sample_number=12, mplex_level=3, platform=4,
file2=txtfile2, metric="hamming", d=3)
## [1] "Theoretical max entropy: 2.48491"
## [1] "Entropy of the optimized set: 2.48491"
## Id Lane
## 1 RPI01 1
## 2 RPI06 1
## 3 RPI08 1
## 4 RPI05 2
## 5 RPI15 2
## 6 RPI18 2
## 7 RPI02 3
## 8 RPI07 3
## 9 RPI20 3
## 10 RPI09 4
## 11 RPI11 4
## 12 RPI12 4
## [1] "Theoretical max entropy: 2.48491"
## [1] "Entropy of the optimized set: 2.48491"
## Id Lane
## 1 RPI29 1
## 2 RPI37 1
## 3 RPI41 1
## 4 RPI31 2
## 5 RPI40 2
## 6 RPI44 2
## 7 RPI35 3
## 8 RPI39 3
## 9 RPI47 3
## 10 RPI26 4
## 11 RPI28 4
## 12 RPI45 4
## Id Lane sequence
## 1 RPI01 1 ATCACG
## 2 RPI06 1 GCCAAT
## 3 RPI08 1 ACTTGA
## 4 RPI05 2 ACAGTG
## 5 RPI15 2 ATGTCA
## 6 RPI18 2 GTCCGC
## 7 RPI02 3 CGATGT
## 8 RPI07 3 CAGATC
## 9 RPI20 3 GTGGCC
## 10 RPI09 4 GATCAG
## 11 RPI11 4 GGCTAC
## 12 RPI12 4 CTTGTA
## Id Lane sequence
## 1 RPI29 1 CAACTA
## 2 RPI37 1 CGGAAT
## 3 RPI41 1 GACGAC
## 4 RPI31 2 CACGAT
## 5 RPI40 2 CTCAGA
## 6 RPI44 2 TATAAT
## 7 RPI35 3 CATTTT
## 8 RPI39 3 CTATAC
## 9 RPI47 3 TCGAAG
## 10 RPI26 4 ATGAGC
## 11 RPI28 4 CAAAAG
## 12 RPI45 4 TCATTC
## sample Lane Id1 sequence1 Id2 sequence2
## 1 1 1 RPI01 ATCACG RPI29 CAACTA
## 2 2 1 RPI06 GCCAAT RPI37 CGGAAT
## 3 3 1 RPI08 ACTTGA RPI41 GACGAC
## 4 4 2 RPI05 ACAGTG RPI31 CACGAT
## 5 5 2 RPI15 ATGTCA RPI40 CTCAGA
## 6 6 2 RPI18 GTCCGC RPI44 TATAAT
## 7 7 3 RPI02 CGATGT RPI35 CATTTT
## 8 8 3 RPI07 CAGATC RPI39 CTATAC
## 9 9 3 RPI20 GTGGCC RPI47 TCGAAG
## 10 10 4 RPI09 GATCAG RPI26 ATGAGC
## 11 11 4 RPI11 GGCTAC RPI28 CAAAAG
## 12 12 4 RPI12 CTTGTA RPI45 TCATTCThis section guides you through the detailed API of the package with the aim to
help you build your own workflow. The package is designed to be flexible and
should be easily adaptable to most experimental contexts, using the
experiment_design() function as a template, or building your own workflow
from scratch.
The file_loading_and_checking() function loads the file containing the DNA
barcodes set and analyzes its content. In particular, it checks that each
barcode in the set is unique and uniquely identified (removing any repetition
that occurs). It also checks the homogeneity of size of the barcodes,
calculates their GC content and detects the presence of homopolymers of
length >= 3.
file_loading_and_checking(
file = export_dataset_to_file(
dataset = DNABarcodeCompatibility::IlluminaIndexesRaw
)
)
## Id sequence GC_content homopolymer
## 1 RPI01 ATCACG 50.00 FALSE
## 2 RPI02 CGATGT 50.00 FALSE
## 3 RPI03 TTAGGC 50.00 FALSE
## 4 RPI04 TGACCA 50.00 FALSE
## 5 RPI05 ACAGTG 50.00 FALSE
## 6 RPI06 GCCAAT 50.00 FALSE
## 7 RPI07 CAGATC 50.00 FALSE
## 8 RPI08 ACTTGA 33.33 FALSE
## 9 RPI09 GATCAG 50.00 FALSE
## 10 RPI10 TAGCTT 33.33 FALSE
## 11 RPI11 GGCTAC 66.67 FALSE
## 12 RPI12 CTTGTA 33.33 FALSE
## 13 RPI13 AGTCAA 33.33 FALSE
## 14 RPI14 AGTTCC 50.00 FALSE
## 15 RPI15 ATGTCA 33.33 FALSE
## 16 RPI16 CCGTCC 83.33 FALSE
## 17 RPI17 GTAGAG 50.00 FALSE
## 18 RPI18 GTCCGC 83.33 FALSE
## 19 RPI19 GTGAAA 33.33 TRUE
## 20 RPI20 GTGGCC 83.33 FALSE
## 21 RPI21 GTTTCG 50.00 TRUE
## 22 RPI22 CGTACG 66.67 FALSE
## 23 RPI23 GAGTGG 66.67 FALSE
## 24 RPI24 GGTAGC 66.67 FALSE
## 25 RPI25 ACTGAT 33.33 FALSE
## 26 RPI26 ATGAGC 50.00 FALSE
## 27 RPI27 ATTCCT 33.33 FALSE
## 28 RPI28 CAAAAG 33.33 TRUE
## 29 RPI29 CAACTA 33.33 FALSE
## 30 RPI30 CACCGG 83.33 FALSE
## 31 RPI31 CACGAT 50.00 FALSE
## 32 RPI32 CACTCA 50.00 FALSE
## 33 RPI33 CAGGCG 83.33 FALSE
## 34 RPI34 CATGGC 66.67 FALSE
## 35 RPI35 CATTTT 16.67 TRUE
## 36 RPI36 CCAACA 50.00 FALSE
## 37 RPI37 CGGAAT 50.00 FALSE
## 38 RPI38 CTAGCT 50.00 FALSE
## 39 RPI39 CTATAC 33.33 FALSE
## 40 RPI40 CTCAGA 50.00 FALSE
## 41 RPI41 GACGAC 66.67 FALSE
## 42 RPI42 TAATCG 33.33 FALSE
## 43 RPI43 TACAGC 50.00 FALSE
## 44 RPI44 TATAAT 0.00 FALSE
## 45 RPI45 TCATTC 33.33 FALSE
## 46 RPI46 TCCCGA 66.67 TRUE
## 47 RPI47 TCGAAG 50.00 FALSE
## 48 RPI48 TCGGCA 66.67 FALSEThe total number of combinations depends on the number of available barcodes
and of the multiplex level. For 48 barcodes and a multiplex level of 3, the
total number of combinations (compatible or not) can be calculated using
choose(48,3), which gives 17296 combinations. In many
cases the total number of combinations can become much larger (even gigantic),
and one cannot perform an exhaustive search
(see get_random_combinations() below).
# Total number of combinations
choose(48,2)
## [1] 1128
# Load barcodes
barcodes <- DNABarcodeCompatibility::IlluminaIndexes
# Time for an exhaustive search
system.time(m <- get_all_combinations(index_df = barcodes,
mplex_level = 2,
platform = 4))
## user system elapsed
## 0.495 0.000 0.495
# Each line represents a compatible combination of barcodes
head(m)
## [,1] [,2]
## [1,] "RPI04" "RPI35"
## [2,] "RPI05" "RPI19"
## [3,] "RPI06" "RPI12"
## [4,] "RPI07" "RPI17"
## [5,] "RPI10" "RPI39"
## [6,] "RPI18" "RPI25"# Total number of combinations
choose(48,3)
## [1] 17296
# Load barcodes
barcodes <- DNABarcodeCompatibility::IlluminaIndexes
# Time for an exhaustive search
system.time(m <- get_all_combinations(index_df = barcodes,
mplex_level = 3,
platform = 4))
## user system elapsed
## 5.971 0.032 6.002
# Each line represents a compatible combination of barcodes
head(m)
## [,1] [,2] [,3]
## [1,] "RPI01" "RPI02" "RPI48"
## [2,] "RPI01" "RPI03" "RPI07"
## [3,] "RPI01" "RPI03" "RPI08"
## [4,] "RPI01" "RPI03" "RPI09"
## [5,] "RPI01" "RPI03" "RPI10"
## [6,] "RPI01" "RPI03" "RPI16"When the total number of combinations is too high, it is recommended to pick combinations at random and then select those that are compatible.
# Total number of combinations
choose(48,3)
## [1] 17296
# Load barcodes
barcodes <- DNABarcodeCompatibility::IlluminaIndexes
# Time for a random search
system.time(m <- get_random_combinations(index_df = barcodes,
mplex_level = 2,
platform = 4))
## user system elapsed
## 0.208 0.000 0.207
# Each line represents a compatible combination of barcodes
head(m)
## [,1] [,2]
## [1,] "RPI05" "RPI19"
## [2,] "RPI07" "RPI17"
## [3,] "RPI18" "RPI33"
## [4,] "RPI22" "RPI45"
## [5,] "RPI24" "RPI31"
## [6,] "RPI27" "RPI45"# Total number of combinations
choose(48,4)
## [1] 194580
# Load barcodes
barcodes <- DNABarcodeCompatibility::IlluminaIndexes
# Time for a random search
system.time(m <- get_random_combinations(index_df = barcodes,
mplex_level = 4,
platform = 4))
## user system elapsed
## 1.067 0.000 1.067
# Each line represents a compatible combination of barcodes
head(m)
## [,1] [,2] [,3] [,4]
## [1,] "RPI01" "RPI02" "RPI09" "RPI13"
## [2,] "RPI01" "RPI17" "RPI24" "RPI42"
## [3,] "RPI01" "RPI08" "RPI40" "RPI42"
## [4,] "RPI01" "RPI11" "RPI21" "RPI35"
## [5,] "RPI01" "RPI23" "RPI40" "RPI47"
## [6,] "RPI01" "RPI26" "RPI33" "RPI44"# Total number of combinations
choose(48,6)
## [1] 12271512
# Load barcodes
barcodes <- DNABarcodeCompatibility::IlluminaIndexes
# Time for a random search
system.time(m <- get_random_combinations(index_df = barcodes,
mplex_level = 6,
platform = 4))
## user system elapsed
## 1.695 0.000 1.696
# Each line represents a compatible combination of barcodes
head(m)
## [,1] [,2] [,3] [,4] [,5] [,6]
## [1,] "RPI01" "RPI13" "RPI21" "RPI32" "RPI35" "RPI48"
## [2,] "RPI01" "RPI06" "RPI16" "RPI20" "RPI23" "RPI38"
## [3,] "RPI01" "RPI03" "RPI10" "RPI19" "RPI39" "RPI46"
## [4,] "RPI01" "RPI07" "RPI08" "RPI23" "RPI36" "RPI47"
## [5,] "RPI01" "RPI08" "RPI09" "RPI22" "RPI29" "RPI33"
## [6,] "RPI01" "RPI22" "RPI24" "RPI40" "RPI43" "RPI45"# Load barcodes
barcodes <- DNABarcodeCompatibility::IlluminaIndexes
# Perform a random search of compatible combinations
m <- get_random_combinations(index_df = barcodes,
mplex_level = 3,
platform = 4)
# Keep barcodes that are robust against one substitution error
filtered_m <- distance_filter(index_df = barcodes,
combinations_m = m,
metric = "hamming",
d = 3)
# Each line represents a compatible combination of barcodes
head(filtered_m)
## V1 V2 V3
## [1,] "RPI01" "RPI10" "RPI12"
## [2,] "RPI01" "RPI08" "RPI42"
## [3,] "RPI01" "RPI26" "RPI41"
## [4,] "RPI01" "RPI14" "RPI43"
## [5,] "RPI01" "RPI07" "RPI42"
## [6,] "RPI01" "RPI08" "RPI41"# Keep set of compatible barcodes that are robust against one substitution
# error
filtered_m <- distance_filter(
index_df = DNABarcodeCompatibility::IlluminaIndexes,
combinations_m = get_random_combinations(index_df = barcodes,
mplex_level = 3,
platform = 4),
metric = "hamming", d = 3)
# Use a Shannon-entropy maximization approach to reduce barcode redundancy
df <- optimize_combinations(combination_m = filtered_m,
nb_lane = 12,
index_number = 48)
## [1] "Theoretical max entropy: 3.58352"
## [1] "Entropy of the optimized set: 3.58352"
# Each line represents a compatible combination of barcodes and each row a lane
# of the flow cell
df
## V1 V2 V3
## [1,] "RPI09" "RPI16" "RPI18"
## [2,] "RPI12" "RPI30" "RPI47"
## [3,] "RPI17" "RPI29" "RPI44"
## [4,] "RPI08" "RPI37" "RPI41"
## [5,] "RPI01" "RPI15" "RPI23"
## [6,] "RPI21" "RPI40" "RPI43"
## [7,] "RPI13" "RPI22" "RPI45"
## [8,] "RPI24" "RPI25" "RPI42"
## [9,] "RPI27" "RPI32" "RPI46"
## [10,] "RPI05" "RPI19" "RPI36"
## [11,] "RPI10" "RPI26" "RPI38"
## [12,] "RPI02" "RPI20" "RPI28"# Keep set of compatible barcodes that are robust against multiple substitution
# and insertion/deletion errors
filtered_m <- distance_filter(
index_df = DNABarcodeCompatibility::IlluminaIndexes,
combinations_m = get_random_combinations(index_df = barcodes,
mplex_level = 3,
platform = 4),
metric = "seqlev", d = 4)
# Use a Shannon-entropy maximization approach to reduce barcode redundancy
df <- optimize_combinations(combination_m = filtered_m,
nb_lane = 12,
index_number = 48)
## [1] "Theoretical max entropy: 3.58352"
## [1] "Entropy of the optimized set: 3.10689"
# Each line represents a compatible combination of barcodes and each row a
# lane of the flow cell
df
## V1 V2 V3
## [1,] "RPI06" "RPI24" "RPI33"
## [2,] "RPI06" "RPI12" "RPI33"
## [3,] "RPI12" "RPI23" "RPI28"
## [4,] "RPI13" "RPI20" "RPI30"
## [5,] "RPI14" "RPI30" "RPI44"
## [6,] "RPI14" "RPI17" "RPI30"
## [7,] "RPI16" "RPI17" "RPI29"
## [8,] "RPI18" "RPI35" "RPI42"
## [9,] "RPI18" "RPI34" "RPI44"
## [10,] "RPI19" "RPI38" "RPI45"
## [11,] "RPI20" "RPI35" "RPI43"
## [12,] "RPI27" "RPI29" "RPI48"