Add usage instructions to the README

.gitignore

@@ -1,3 +1 @@
-*.csv
-*.fasta
 *.fastq

README.org

@@ -1,3 +1,49 @@
 * locigenesis
 
 locigenesis is a tool that generates an immune repertoire and runs it through a sequence reader simulation tool, to generate sequencing errors.
+
+** Installation
+
+This project uses [[https://nixos.org/][Nix]] to ensure reproducible builds.
+
+1. Install Nix (compatible with MacOS, Linux and [[https://docs.microsoft.com/en-us/windows/wsl/about][WSL]]):
+
+#+begin_src shell
+curl -L https://nixos.org/nix/install | sh
+#+end_src
+
+1. Clone the repository:
+
+#+begin_src shell
+git clone https://git.coolneng.duckdns.org/coolneng/locigenesis
+#+end_src
+
+3. Change the working directory to the project:
+
+#+begin_src shell
+cd locigenesis
+#+end_src
+
+4. Enter the nix-shell:
+
+#+begin_src shell
+nix-shell
+#+end_src
+
+After running these commands, you will find yourself in a shell that contains all the needed dependencies.
+
+** Usage
+
+An execution script that accepts 2 parameters is provided, the following command invokes it:
+
+#+begin_src shell
+./generation.sh <number of sequences> <number of reads>
+#+end_src
+
+- <number of sequences>: an integer that specifies the number of different sequences to generate
+- <number of reads>: an integer that specifies the number of reads to perform on each sequence
+
+The script will generate 2 files under the data directory:
+
+| HVR.fastq         | Contains the original CDR3 sequence                             |
+| CuReSim-HVR.fastq | Contains CDR3 after the read simulation, with sequencing errors |

generation.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 usage() {
-	echo "usage: generation.sh <number of sequences> <sequencing runs>"
+	echo "usage: generation.sh <number of sequences> <number of reads>"
 	exit 1
 }
 
@@ -10,15 +10,13 @@ if [ $# != 2 ]; then
 fi
 
 sequences=$1
-sequencing_runs=$2
+number_of_reads=$2
-read_mean_size=350
-read_variance_size=0.0
 data_directory="data/"
-fasta=".fasta"
 fastq=".fastq"
 filename="sequence"
 prefix="curesim_"
 
-Rscript src/repertoire.r "$sequences" "$sequencing_runs"
+Rscript src/repertoire.r "$sequences" "$number_of_reads" &&
-java -jar tools/CuReSim.jar -m "$read_mean_size" -sd "$read_variance_size" -f "$data_directory$filename$fasta" -o "$data_directory$prefix$filename$fastq"
+	CuReSim -f "$data_directory$filename$fastq" -o "$data_directory$prefix$filename$fastq"
+Rscript src/alignment.r
 rm "$data_directory/log.txt"

shell.nix

@@ -2,14 +2,35 @@
 
 with pkgs;
 
-mkShell {
+let
+  CuReSim = stdenv.mkDerivation rec {
+    name = "CuReSim";
+    version = "1.3";
+    src = fetchzip {
+      url =
+        "http://www.pegase-biosciences.com/wp-content/uploads/2015/08/${name}${version}.zip";
+      sha256 = "1hvlpgy4haqgqq52mkxhcl9i1fx67kgwi6f1mijvqzk0xff77hkp";
+      stripRoot = true;
+      extraPostFetch = ''
+        chmod go-w $out
+      '';
+    };
+
+    nativeBuildInputs = [ makeWrapper ];
+
+    installPhase = ''
+      mkdir -pv $out/share/java $out/bin
+      cp -r ${src} $out/share/java/${name}
+      makeWrapper ${pkgs.jdk}/bin/java $out/bin/CuReSim --add-flags "-jar $out/share/java/${name}/${name}.jar"
+    '';
+  };
+in mkShell {
   buildInputs = [
     R
     rPackages.immuneSIM
     rPackages.Biostrings
+    rPackages.stringr
     jdk
-    # Development tools
+    CuReSim
-    rPackages.languageserver
-    rPackages.lintr
   ];
 }

src/alignment.r

@@ -1,44 +1,101 @@
 library(Biostrings)
 library(parallel)
 
-construct_dataframe <- function(data) {
+parse_data <- function(file) {
-  vdj_string_set <- lapply(data, FUN = Biostrings::DNAStringSet)
+  reversed_sequences <- Biostrings::readQualityScaledDNAStringSet(file)
-  vdj_dataframe <- as.data.frame(vdj_string_set)
+  sequences <- Biostrings::reverseComplement(reversed_sequences)
-  vdj_dataframe$hvr_region <- paste(vdj_dataframe$v_sequence,
+  vj_segments <- union(
-    vdj_dataframe$d_sequence,
+    readRDS("data/v_segments.rds"),
-    vdj_dataframe$j_sequence,
+    readRDS("data/j_segments_phe.rds")
-    sep = ""
   )
-  return(vdj_dataframe)
+  return(list(sequences, vj_segments))
 }
 
-parse_data <- function(files) {
+parse_metadata <- function(metadata) {
-  reversed_sequences <- Biostrings::readQualityScaledDNAStringSet(files[1])
+  id_elements <- unlist(strsplit(metadata, split = " "))
-  sequences <- Biostrings::reverseComplement(reversed_sequences)
+  v_identifier <- id_elements[2]
-  vdj_alignment <- read.csv(files[2])
+  j_identifier <- id_elements[3]
-  vdj_dataframe <- construct_dataframe(vdj_alignment)
+  return(list(v_id = v_identifier, j_id = j_identifier))
-  return(list(sequences, vdj_dataframe))
+}
+
+match_id_sequence <- function(names, vdj_segments, id) {
+  matches <- grep(names, pattern = id)
+  row <- matches[1]
+  return(as.character(vdj_segments[row]))
+}
+
+get_vj_sequence <- function(metadata, names, vdj_segments) {
+  identifiers <- parse_metadata(metadata)
+  v_sequence <- match_id_sequence(names, vdj_segments, id = identifiers["v_id"])
+  j_sequence <- match_id_sequence(names, vdj_segments, id = identifiers["j_id"])
+  return(list(v_seq = v_sequence, j_seq = j_sequence))
+}
+
+fetch_vj_sequences <- function(sequences, vdj_segments) {
+  vj_sequences <- sapply(names(sequences),
+    names(vdj_segments),
+    vdj_segments,
+    FUN = get_vj_sequence
+  )
+  results <- data.frame(t(vj_sequences))
+  return(results)
 }
 
 align_sequence <- function(sequence, vdj_segment) {
   return(Biostrings::pairwiseAlignment(
-    pattern = sequence,
+    subject = sequence,
-    subject = vdj_segment,
+    pattern = vdj_segment,
     type = "global-local",
     gapOpening = 1
   ))
 }
 
-perform_alignment <- function(sequences, vdj_segments) {
+handle_indels <- function(insertion, deletion, cys, alignment) {
-  sequence_alignment <- mcmapply(sequences,
+  ins_start <- sum(Biostrings::width(deletion[start(deletion) <= cys$start]))
-    vdj_segments$hvr_region,
+  ins_end <- sum(Biostrings::width(deletion[end(deletion) <= cys$end]))
-    FUN = align_sequence,
+  shift_num <- c(0, cumsum(Biostrings::width(insertion))[-length(ins_start)])
-    mc.cores = 4
+  shifted_ins <- IRanges::shift(insertion, shift_num)
-  )
+  gaps <- sum(width(shifted_ins[end(shifted_ins) < cys$start + ins_start])) +
-  return(sequence_alignment)
+    nchar(stringr::str_extract(alignedSubject(alignment), "^-*"))
+  return(list("start" = ins_start - gaps, "end" = ins_end - gaps))
 }
 
-input_files <- c("data/curesim_sequence.fastq", "data/vdj_alignment.csv")
+get_cys_coordinates <- function(alignment) {
-data <- parse_data(input_files)
+  cys <- list("start" = 310, "end" = 312)
-alignment <- perform_alignment(sequences = data[[1]], vdj_segments = data[[2]])
+  insertion <- unlist(Biostrings::insertion(alignment))
-print(alignment)
+  deletion <- unlist(Biostrings::deletion(alignment))
+  delta_coordinates <- handle_indels(insertion, deletion, cys, alignment)
+  cys_start <- cys$start + delta_coordinates$start
+  cys_end <- cys$end + delta_coordinates$end
+  return(list("start" = cys_start, "end" = cys_end))
+}
+
+get_hvr_sequences <- function(sequences, vdj_segments, cores = detectCores()) {
+  df <- fetch_vj_sequences(sequences, vdj_segments)
+  v_alignment <- parallel::mcmapply(sequences,
+    df$v_seq,
+    FUN = align_sequence,
+    mc.cores = cores
+  )
+  cys_coordinates <- parallel::mclapply(v_alignment, FUN = get_cys_coordinates)
+  cys_df <- as.data.frame(do.call(rbind, cys_coordinates))
+  remaining <- Biostrings::subseq(sequences, start = unlist(cys_df$end))
+  j_alignment <- parallel::mcmapply(remaining,
+    df$j_seq,
+    FUN = align_sequence,
+    mc.cores = cores
+  )
+  j_start <- parallel::mclapply(
+    j_alignment,
+    function(x) start(Biostrings::Views(x)),
+    mc.cores = cores
+  )
+  hvr_start <- unlist(cys_df$start)
+  hvr_end <- unlist(cys_df$start) + unlist(j_start) + 2
+  hvr <- Biostrings::subseq(sequences, start = hvr_start, end = hvr_end)
+  return(hvr)
+}
+
+data <- parse_data(file = "data/curesim_sequence.fastq")
+hvr <- get_hvr_sequences(sequences = data[[1]], vdj_segments = data[[2]])
+Biostrings::writeXStringSet(hvr, "data/CuReSim-HVR.fastq", format = "fastq")

src/repertoire.r

@@ -10,44 +10,33 @@ generate_repertoire <- function(number_of_sequences) {
   ))
 }
 
-amplify_rows <- function(data, column, factor) {
-  if (column == "sequence") {
-    dna_string <- Biostrings::DNAStringSet(data)
-    reverse_complement <- Biostrings::reverseComplement(dna_string)
-    return(rep(reverse_complement, factor))
-  }
-  return(rep(data, factor))
-}
-
 save_data <- function(data) {
-  Biostrings::writeXStringSet(data$sequence, "data/sequence.fasta")
+  Biostrings::writeXStringSet(data$sequence,
-  vdj_sequences <- data[-1]
+    "data/sequence.fastq",
-  write.csv(vdj_sequences, "data/vdj_alignment.csv", row.names = FALSE)
+    format = "fastq"
-}
-
-process_data <- function(repertoire, sequencing_runs) {
-  columns <- c(
-    "sequence", "v_sequence_alignment",
-    "d_sequence_alignment", "j_sequence_alignment"
   )
-  data <- repertoire[, columns]
+  Biostrings::writeXStringSet(data$junction, "data/HVR.fastq", format = "fastq")
-  amplified_data <- mapply(data, names(data),
-    sequencing_runs,
-    FUN = amplify_rows
-  )
-  save_data(amplified_data)
 }
 
-parse_cli_arguments <- function(args) {
+process_data <- function(data, reads) {
-  if (length(args) != 2) {
+  dna_sequence <- Biostrings::DNAStringSet(data$sequence)
-    stop("usage: repertoire.r <number of sequences> <sequencing_runs>")
+  data$sequence <- Biostrings::reverseComplement(dna_sequence)
-  }
+  names(data$sequence) <- paste(rownames(data), data$v_call, data$j_call, " ")
-  return(c(args[1], args[2]))
+  data$junction <- Biostrings::DNAStringSet(data$junction)
+  names(data$junction) <- rownames(data)
+  amplified_data <- data[rep(seq_len(nrow(data)), reads), ]
+  return(amplified_data)
 }
 
+parse_cli_arguments <- function() {
   args <- commandArgs(trailingOnly = TRUE)
-arguments <- parse_cli_arguments(args)
+  if (length(args) != 2) {
-number_of_sequences <- as.integer(arguments[1])
+    stop("usage: repertoire.r <number of sequences> <number of reads>")
-sequencing_runs <- as.integer(arguments[2])
+  }
-repertoire <- generate_repertoire(number_of_sequences)
+  return(args)
-process_data(repertoire, sequencing_runs)
+}
+
+args <- parse_cli_arguments()
+repertoire <- generate_repertoire(number_of_sequences = as.integer(args[1]))
+data <- process_data(data = repertoire, reads = args[2])
+save_data(data)