Header menu logo BioFSharp

STAR Module

Types and nested modules

Type/Module Description

BasicWorkflows

AligmentPairedEndReadOptions

AlignmentChimericOptions

AlignmentEndsProtrusionOptions

maximum and type of allowed allow protrusion of alignment ends, i.e. start (end) of the +strand mate downstream of the start (end) of the -strand mate

AlignmentEndsTypeOptions

type of read ends alignment

AlignmentGeneralOptions

AlignmentInsertionFlushOptions

how to flush ambiguous insertion positions

AlignmentOrder

AlignmentParams

AlignmentScoringOptions

AlignmentSeedOptions

AlignmentWindowOptions

Windows, Anchors, Binning Options

AnnotationQuantificationModeOptions

types of quantification requested

AnnotationQuantificationParams

AttributeOptions

desired SAM attributes, in the order desired for the output SAM

BAMHandlingOptions

ChimericAlignmentFilterOptions

different filters for chimeric alignments

ChimericAlignmentOutputTypeOptions

type of chimeric output

ChimericOutJunctionFormatOptions

formatting type for the Chimeric.out.junction file

GenomeIndexingOptions

Genome Indexing Parameters - only used with --runMode genomeGenerate

GenomeLoad

mode of shared memory usage for the genome files. Only used with --runMode alignReads.

GenomeParams

LimitParams

MateClippingOptions

clipping options from either end of the mates

MatesLengths

lengths of names,sequences,qualities for both mates are the same / not the same. NotEqual is safe in all situations.

OutputFilterIntronMotifsOptions

filter alignment using their motifs

OutputFilterOptions

filter the output into main SAM/BAM files

OutputFilterTypeOptions

OutputFilteringParams

OutputFilteringSpliceJunctionsOptions

OutputFormattingOptions

OutputModeOptions

mode of SAM output

OutputParams

OutputSTDOptions

OutputSortingOptions

type of sorting for the SAM output

OutputTypeOptions

type of SAM/BAM output

OutputWiggleParams

PrimaryFlagOptions

which alignments are considered primary - all others will be marked with 0x100 bit in the FLAG

ReadFilesType

format of input read files

ReadIDOptions

read ID record type

ReadParams

RemoveDuplicatesTypeOptions

mark duplicates in the BAM file, for now only works with (i) sorted BAM fed with inputBAMfile, and (ii) for paired-end alignments only

RunMode

type of the STAR run

RunParams

RunPermission

SAMSortingOptions

STARParams

STARSoloBarcodeReadLengthOptions

length of the barcode read

STARSoloCellBarcodeWhiteListOptions

matching the Cell Barcodes to the WhiteList

STARSoloCellFilterOptions

cell filtering type and parameters

STARSoloFeaturesOptions

genomic features for which the UMI counts per Cell Barcode are collected

STARSoloParams

STARSoloStrandOptions

strandedness of the solo libraries:

STARSoloTypeOptions

type of single-cell RNA-seq

STARSoloUMIDeDuplicationOptions

type of UMI deduplication (collapsing) algorithm

STARSoloUMIFilteringOptions

type of UMI filtering

SpliceJunctionsDatabaseParams

SpliceJunctionsDatabaseSaveOptions

which files to save when sjdb junctions are inserted on the fly at the mapping step

SpliceJunctionsFilterReadOptions

which reads to consider for collapsed splice junctions output

StrandFieldOptions

Cufflinks-like strand field flag

TranscriptomeBanOptions

prohibit various alignment type

TwoPassMappingParams

TwoPassModeOptions

2-pass mapping mode.

UnmappedReadOptions

output of unmapped reads in the SAM format

WASPOutputModeOptions

WASP allele-specific output type. This is re-implemenation of the original WASP mappability filtering by Bryce van de Geijn, Graham McVicker, Yoav Gilad & Jonathan K Pritchard. Please cite the original WASP paper: Nature Methods 12, 1061�1063 (2015), https://www.nature.com/articles/nmeth.3582 .

WASPParams

WiggleNormalizationOptions

WiggleSignal

WiggleStrandOptions

WiggleTypeOptions

type of signal output, e.g. "bedGraph" OR "bedGraph read1_5p". Requires sorted BAM: --outSAMtype BAM SortedByCoordinate .

Functions and values

Function or value Description

runSTARAsync bcContext opt

Full Usage: runSTARAsync bcContext opt

Parameters:
Returns: Async<unit>
bcContext : BcContext
opt : STARParams list
Returns: Async<unit>

runStar bcContext opt

Full Usage: runStar bcContext opt

Parameters:
bcContext : BcContext
opt : STARParams list

Type something to start searching.