star/star_align_reads

align
fasta
genome

Description

Aligns reads to a reference genome using STAR.

Type

python_script

License

MIT

Keywords

align
fasta
genome

Contributors

Run this component

Run the following command to execute this component with Nextflow:

cat > params.yaml <<'EOM'  
aligned_reads: "$id.$key.aligned_reads.bam"  
reads_per_gene: "$id.$key.reads_per_gene.tsv"  
unmapped: "$id.$key.unmapped.fastq"  
unmapped_r2: "$id.$key.unmapped_r2.fastq"  
chimeric_junctions: "$id.$key.chimeric_junctions.tsv"  
log: "$id.$key.log.txt"  
splice_junctions: "$id.$key.splice_junctions.tsv"  
reads_aligned_to_transcriptome: "$id.$key.reads_aligned_to_transcriptome.bam"  
id: "run"  
publish_dir: "output/"  
EOM

nextflow run https://packages.viash-hub.com/vsh/biobox.git \  
  -revision v0.3.1 \  
  -main-script target/nextflow/star/star_align_reads/main.nf \  
  -params-file params.yaml  

Run Parameters

Name
Type & Properties
--run_rng_seed
integer

Genome Parameters

Name
Type & Properties
--genome_dir
file
required
--genome_load
string
--genome_fasta_files
file
multiple
--genome_file_sizes
integer
multiple
--genome_transform_output
string
multiple
--genome_chr_set_mitochondrial
string
multiple

Splice Junctions Database

Name
Type & Properties
--sjdb_file_chr_start_end
string
multiple
--sjdb_gtf_file
file
--sjdb_gtf_chr_prefix
string
--sjdb_gtf_feature_exon
string
--sjdb_gtf_tag_exon_parent_transcript
string
--sjdb_gtf_tag_exon_parent_gene
string
--sjdb_gtf_tag_exon_parent_gene_name
string
multiple
--sjdb_gtf_tag_exon_parent_gene_type
string
multiple
--sjdb_overhang
integer
--sjdb_score
integer
--sjdb_insert_save
string

Variation parameters

Name
Type & Properties
--var_vcf_file
string

Read Parameters

Name
Type & Properties
--read_files_type
string
--read_files_sam_attr_keep
string
multiple
--read_files_manifest
file
--read_files_prefix
string
--read_files_command
string
multiple
--read_map_number
integer
--read_mates_lengths_in
string
--read_name_separator
string
multiple
--read_quality_score_base
integer

Read Clipping

Name
Type & Properties
--clip_adapter_type
string
--clip3p_nbases
integer
multiple
--clip3p_adapter_seq
string
multiple
--clip3p_adapter_mm_p
double
multiple
--clip3p_after_adapter_nbases
integer
multiple
--clip5p_nbases
integer
multiple

Limits

Name
Type & Properties
--limit_genome_generate_ram
long
--limit_io_buffer_size
long
multiple
--limit_out_sam_one_read_bytes
long
--limit_out_sj_one_read
integer
--limit_out_sj_collapsed
integer
--limit_bam_sort_ram
long
--limit_sjdb_insert_nsj
integer
--limit_nreads_soft
integer

Output: general

Name
Type & Properties
--out_tmp_keep
string
--out_std
string
--out_reads_unmapped
string
--out_qs_conversion_add
integer
--out_multimapper_order
string

Output: SAM and BAM

Name
Type & Properties
--out_sam_type
string
multiple
--out_sam_mode
string
--out_sam_strand_field
string
--out_sam_attributes
string
multiple
--out_sam_attr_ih_start
integer
--out_sam_unmapped
string
multiple
--out_sam_order
string
--out_sam_primary_flag
string
--out_sam_read_id
string
--out_sam_mapq_unique
integer
--out_sam_flag_or
integer
--out_sam_flag_and
integer
--out_sam_attr_rg_line
string
multiple
--out_sam_header_hd
string
multiple
--out_sam_header_pg
string
multiple
--out_sam_header_comment_file
string
--out_sam_filter
string
multiple
--out_sam_mult_nmax
integer
--out_sam_tlen
integer
--out_bam_compression
integer
--out_bam_sorting_thread_n
integer
--out_bam_sorting_bins_n
integer

BAM processing

Name
Type & Properties
--bam_remove_duplicates_type
string
--bam_remove_duplicates_mate2bases_n
integer

Output Wiggle

Name
Type & Properties
--out_wig_type
string
multiple
--out_wig_strand
string
--out_wig_references_prefix
string
--out_wig_norm
string

Output Filtering

Name
Type & Properties
--out_filter_type
string
--out_filter_multimap_score_range
integer
--out_filter_multimap_nmax
integer
--out_filter_mismatch_nmax
integer
--out_filter_mismatch_nover_lmax
double
--out_filter_mismatch_nover_read_lmax
double
--out_filter_score_min
integer
--out_filter_score_min_over_lread
double
--out_filter_match_nmin
integer
--out_filter_match_nmin_over_lread
double
--out_filter_intron_motifs
string
--out_filter_intron_strands
string

Output splice junctions (SJ.out.tab)

Name
Type & Properties
--out_sj_type
string

Output Filtering: Splice Junctions

Name
Type & Properties
--out_sj_filter_reads
string
--out_sj_filter_overhang_min
integer
multiple
--out_sj_filter_count_unique_min
integer
multiple
--out_sj_filter_count_total_min
integer
multiple
--out_sj_filter_dist_to_other_sj_min
integer
multiple
--out_sj_filter_intron_max_vs_read_n
integer
multiple

Scoring

Name
Type & Properties
--score_gap
integer
--score_gap_noncan
integer
--score_gap_gcag
integer
--score_gap_atac
integer
--score_genomic_length_log2scale
integer
--score_del_open
integer
--score_del_base
integer
--score_ins_open
integer
--score_ins_base
integer
--score_stitch_sj_shift
integer

Alignments and Seeding

Name
Type & Properties
--seed_search_start_lmax
integer
--seed_search_start_lmax_over_lread
double
--seed_search_lmax
integer
--seed_multimap_nmax
integer
--seed_per_read_nmax
integer
--seed_per_window_nmax
integer
--seed_none_loci_per_window
integer
--seed_split_min
integer
--seed_map_min
integer
--align_intron_min
integer
--align_intron_max
integer
--align_mates_gap_max
integer
--align_sj_overhang_min
integer
--align_sj_stitch_mismatch_nmax
integer
multiple
--align_sjdb_overhang_min
integer
--align_spliced_mate_map_lmin
integer
--align_spliced_mate_map_lmin_over_lmate
double
--align_windows_per_read_nmax
integer
--align_transcripts_per_window_nmax
integer
--align_transcripts_per_read_nmax
integer
--align_ends_type
string
--align_ends_protrude
string
--align_soft_clip_at_reference_ends
string
--align_insertion_flush
string

Paired-End reads

Name
Type & Properties
--pe_overlap_nbases_min
integer
--pe_overlap_mm_p
double

Windows, Anchors, Binning

Name
Type & Properties
--win_anchor_multimap_nmax
integer
--win_bin_nbits
integer
--win_anchor_dist_nbins
integer
--win_flank_nbins
integer
--win_read_coverage_relative_min
double
--win_read_coverage_bases_min
integer

Chimeric Alignments

Name
Type & Properties
--chim_out_type
string
multiple
--chim_segment_min
integer
--chim_score_min
integer
--chim_score_drop_max
integer
--chim_score_separation
integer
--chim_score_junction_non_gtag
integer
--chim_junction_overhang_min
integer
--chim_segment_read_gap_max
integer
--chim_filter
string
multiple
--chim_main_segment_mult_nmax
integer
--chim_multimap_nmax
integer
--chim_multimap_score_range
integer
--chim_nonchim_score_drop_min
integer
--chim_out_junction_format
integer

Quantification of Annotations

Name
Type & Properties
--quant_mode
string
multiple
--quant_transcriptome_bam_compression
integer
--quant_transcriptome_sam_output
string

2-pass Mapping

Name
Type & Properties
--twopass_mode
string
--twopass1reads_n
integer

WASP parameters

Name
Type & Properties
--wasp_output_mode
string

STARsolo (single cell RNA-seq) parameters

Name
Type & Properties
--solo_type
string
multiple
--solo_cb_type
string
--solo_cb_whitelist
string
multiple
--solo_cb_start
integer
--solo_cb_len
integer
--solo_umi_start
integer
--solo_umi_len
integer
--solo_barcode_read_length
integer
--solo_barcode_mate
integer
--solo_cb_position
string
multiple
--solo_umi_position
string
--solo_adapter_sequence
string
--solo_adapter_mismatches_nmax
integer
--solo_cb_match_wl_type
string
--solo_input_sam_attr_barcode_seq
string
multiple
--solo_input_sam_attr_barcode_qual
string
multiple
--solo_strand
string
--solo_features
string
multiple
--solo_multi_mappers
string
multiple
--solo_umi_dedup
string
multiple
--solo_umi_filtering
string
multiple
--solo_out_file_names
string
multiple
--solo_cell_filter
string
multiple
--solo_out_format_features_gene_field3
string
multiple
--solo_cell_read_stats
string

Inputs

Name
Type & Properties
--input
--readFilesIn
file
required
multiple
--input_r2
file
multiple

Outputs

Name
Type & Properties
--aligned_reads
file
required
output
--reads_per_gene
file
output
--unmapped
file
output
--unmapped_r2
file
output
--chimeric_junctions
file
output
--log
file
output
--splice_junctions
file
output
--reads_aligned_to_transcriptome
file
output

Collaborate Accelerate Succeed

Empower your organization with secure, scalable workflow solutions that simplify development, ensure compliance, and drive innovation.

Viash Hub is a platform developed by Data Intuitive, a Belgian-based bioinformatics company specializing in data workflow development and deployment.