Skip to contents

Set steps to perform in the pipeline

Usage

steps(object) <- value

# S4 method for class 'FLAMES.Pipeline'
steps(object) <- value

Arguments

object

An object of class `FLAMES.Pipeline`

value

A named logical vector containing all possible steps for the pipeline. The names of the vector are the step names, and the values are logical indicating whether the step is configured to be performed.

Value

An object of class `FLAMES.Pipeline` with the updated steps.

Examples

ppl <- example_pipeline()
#> Writing configuration parameters to:  /tmp/RtmpgpEV0i/file25bf53c5338d/config_file_9663.json 
#> Configured steps: 
#> 	barcode_demultiplex: TRUE
#> 	genome_alignment: TRUE
#> 	gene_quantification: TRUE
#> 	isoform_identification: TRUE
#> 	read_realignment: TRUE
#> 	transcript_quantification: TRUE
#> samtools not found, will use Rsamtools package instead
steps(ppl) <- c(
  barcode_demultiplex = TRUE,
  genome_alignment = TRUE,
  gene_quantification = TRUE,
  isoform_identification = FALSE,
  read_realignment = FALSE,
  transcript_quantification = TRUE
)
ppl
#> → A FLAMES.SingleCellPipeline outputting to /tmp/RtmpgpEV0i/file25bf53c5338d
#> 
#> ── Inputs 
#>  fastq: ...ibrary/FLAMES/extdata/fastq/musc_rps24.fastq.gz
#>  annotation: /__w/_temp/Library/FLAMES/extdata/rps24.gtf.gz
#>  genome_fa: /tmp/RtmpgpEV0i/file25bf53c5338d/rps24.fa
#>  barcodes_file: /tmp/RtmpgpEV0i/file25bf53c5338d/bc_allow.tsv
#> 
#> ── Outputs 
#>  demultiplexed_fastq: matched_reads.fastq
#>  deduped_fastq: matched_reads_dedup.fastq
#>  genome_bam: align2genome.bam
#>  transcriptome_assembly: transcript_assembly.fa
#>  transcriptome_bam: realign2transcript.bam
#> 
#> ── Pipeline Steps 
#>  barcode_demultiplex (pending)
#>  genome_alignment (pending)
#>  gene_quantification (pending)
#>  transcript_quantification (pending)
# or partially change a step:
steps(ppl)["read_realignment"] <- TRUE
ppl
#> → A FLAMES.SingleCellPipeline outputting to /tmp/RtmpgpEV0i/file25bf53c5338d
#> 
#> ── Inputs 
#>  fastq: ...ibrary/FLAMES/extdata/fastq/musc_rps24.fastq.gz
#>  annotation: /__w/_temp/Library/FLAMES/extdata/rps24.gtf.gz
#>  genome_fa: /tmp/RtmpgpEV0i/file25bf53c5338d/rps24.fa
#>  barcodes_file: /tmp/RtmpgpEV0i/file25bf53c5338d/bc_allow.tsv
#> 
#> ── Outputs 
#>  demultiplexed_fastq: matched_reads.fastq
#>  deduped_fastq: matched_reads_dedup.fastq
#>  genome_bam: align2genome.bam
#>  transcriptome_assembly: transcript_assembly.fa
#>  transcriptome_bam: realign2transcript.bam
#> 
#> ── Pipeline Steps 
#>  barcode_demultiplex (pending)
#>  genome_alignment (pending)
#>  gene_quantification (pending)
#>  read_realignment (pending)
#>  transcript_quantification (pending)