Header menu logo BioFSharp

ReadParams Type

Union cases

Union case Description

FilesCommand string list

Full Usage: FilesCommand string list

Parameters:
    Item : string list

command line to execute for each of the input file. This command should generate FASTA or FASTQ text and send it to stdout For example: zcat - to uncompress .gz files, bzcat - to uncompress .bz2 files, etc.

Item : string list

FilesIn(string, string option)

Full Usage: FilesIn(string, string option)

Parameters:
    Item1 : string
    Item2 : string option

paths to files that contain input read1 (and, if needed, read2)

Item1 : string
Item2 : string option

FilesPrefix string

Full Usage: FilesPrefix string

Parameters:
    Item : string

prefix for the read files names, i.e. it will be added in front of the strings in --readFilesIn

Item : string

InputFormat ReadFilesType

Full Usage: InputFormat ReadFilesType

Parameters:

format of input read files

Item : ReadFilesType

MapNumber int

Full Usage: MapNumber int

Parameters:
    Item : int

number of reads to map from the beginning of the file

Item : int

MateClipping MateClippingOptions list

Full Usage: MateClipping MateClippingOptions list

Parameters:

clipping options from either end of the mates

Item : MateClippingOptions list

MatesLengthsIn MatesLengths

Full Usage: MatesLengthsIn MatesLengths

Parameters:

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

Item : MatesLengths

NameSeparator string

Full Usage: NameSeparator string

Parameters:
    Item : string

character(s) separating the part of the read names that will be trimmed in output (read name after space is always trimmed)

Item : string

QualityScoreBase int

Full Usage: QualityScoreBase int

Parameters:
    Item : int

number to be subtracted from the ASCII code to get Phred quality score

Item : int

Static members

Static member Description

ReadParams.makeCmd

Full Usage: ReadParams.makeCmd

Returns: ReadParams -> string list
Returns: ReadParams -> string list

ReadParams.makeCmdWith m

Full Usage: ReadParams.makeCmdWith m

Parameters:
Returns: ReadParams -> string list
m : MountInfo
Returns: ReadParams -> string list

Type something to start searching.