nuget server logo nuget api documents
↑

API Docs / SMRUCC.genomics.Interops.NCBI.Extensions / Parser

Parser

Full name SMRUCC.genomics.Interops.NCBI.Extensions.LocalBLAST.BLASTOutput.BlastPlus.Parser Assembly SMRUCC.genomics.Interops.NCBI.Extensions Members 17

01 Syntax

SMRUCC.genomics.Interops.NCBI.Extensions.LocalBLAST.BLASTOutput.BlastPlus.Parser

02 Methods

NameOverloadsSummary
ParsingSizeAuto 1 The parser worker will be select automatically based on the blast output file size.
UltraLarge 1 判断文件的大小是否是输入超大的文件类型的
isUltraLargeFileSize 1 单条字符串的最大长度好像只有700MB的内存左右
LoadBlastOutput 1 Load the blast output from a local file, if the exceptions happened during the data loading process, then a null value will be return.
TryParse 1 Log file size smaller than 512MB is recommended using this loading method, if the log file size is large than 512MB, please using the method Parser.TryParseUltraLarge()).
IsBlastOut 1 判断目标文件是否为一个blast+的原始输出的结果文件
GetType 1 The target blast output text file is from the blastp or blastn?
TryParseBlastnOutput 1 Load the blastn output data.(读取blastn日志输出的数据.)
Transform 2 File processor for the file size which is greater than 10GB.
measureParser 1 获取blastn或者blastp的解析器
__tryParseUltraLarge 1 Dealing with the file size large than 2GB.
TryParseUltraLarge 1 Dealing with the file size large than 2GB.(当Blast日志文件的大小大于100M的时候,可以使用这个方法进行加载,函数会自动判断日志是否为blastn还是blastp)
ParseDbName 1
BuildGrepScript 1

03 Properties

NameOverloadsSummary
DefaultEncoding 1

04 Fields

NameOverloadsSummary
CHUNK_SIZE 1 It seems 768MB possibly is the up bound of the Utf8.GetString function.

05 Members

method ParsingSizeAuto #
ParsingSizeAuto(String, Encoding)

The parser worker will be select automatically based on the blast output file size. (当blast的输出文件非常大的时候,会自动选择分片段解析读取的方法工作)

Parameters
NameTypeDescription
pathString

-

encodingEncoding

-

method UltraLarge #
UltraLarge(String)

判断文件的大小是否是输入超大的文件类型的

Parameters
NameTypeDescription
pathString

-

method isUltraLargeFileSize #
isUltraLargeFileSize(String)

单条字符串的最大长度好像只有700MB的内存左右

method LoadBlastOutput #
LoadBlastOutput(String)

Load the blast output from a local file, if the exceptions happened during the data loading process, then a null value will be return. (读取blast日志文件,当发生错误的时候,函数返回空值)

Parameters
NameTypeDescription
pathString

The file path of the blast output

method TryParse #
TryParse(String, Encoding)

Log file size smaller than 512MB is recommended using this loading method, if the log file size is large than 512MB, please using the method Parser.TryParseUltraLarge(). (当blast输出的日志文件比较小的时候,可以使用当前的这个方法进行读取)

Parameters
NameTypeDescription
PathString

Original plant text file path of the blast output file.

method IsBlastOut #
IsBlastOut(String)

判断目标文件是否为一个blast+的原始输出的结果文件

Parameters
NameTypeDescription
path$String

-

method GetType #
GetType(String, Encoding)

The target blast output text file is from the blastp or blastn?

Parameters
NameTypeDescription
pathString

-

EncodingEncoding

-

method TryParseBlastnOutput #
TryParseBlastnOutput(String)

Load the blastn output data.(读取blastn日志输出的数据.)

Parameters
NameTypeDescription
PathString

The blastn output file path.

method Transform #
Transform(Value(Of String), Int64, Action(Of Query), Encoding, ValueTuple(Of String, String))

File processor for the file size which is greater than 10GB. (处理非常大的blast输出文件的时候所需要的,大小大于10GB的文件建议使用这个方法处理)

method Transform overload 2 #
Transform(String, Int32, Action(Of Query()), Encoding, ValueTuple(Of String, String))

处理非常大的blast输出文件的时候所需要的,大小大于10GB的文件建议使用这个方法处理

method measureParser #
measureParser(String)

获取blastn或者blastp的解析器

Parameters
NameTypeDescription
pathString

-

method __tryParseUltraLarge #
__tryParseUltraLarge(String, Int64, Encoding)

Dealing with the file size large than 2GB. (当Blast日志文件的大小大于100M的时候,可以使用这个方法进行加载,函数会自动判断日志是否为blastn还是blastp)

Parameters
NameTypeDescription
pathString

File path of the blast output file.

CHUNK_SIZEInt64

The parameter unit for this value is Byte, so you need to multiply the 1024*1024 to get a MB level value. It seems 768MB possibly is the up bound of the Utf8.GetString function. default is 64MB

method TryParseUltraLarge #
TryParseUltraLarge(String, Int64, Encoding)

Dealing with the file size large than 2GB.(当Blast日志文件的大小大于100M的时候,可以使用这个方法进行加载,函数会自动判断日志是否为blastn还是blastp)

Parameters
NameTypeDescription
pathString

File path of the blast output file.

CHUNK_SIZEInt64

The parameter unit for this value is Byte, so you need to multiply the 1024*1024 to get a MB level value. It seems 768MB possibly is the up bound of the Utf8.GetString function. default is 64MB

field CHUNK_SIZE #
CHUNK_SIZE

It seems 768MB possibly is the up bound of the Utf8.GetString function.

property DefaultEncoding #
DefaultEncoding
method ParseDbName #
ParseDbName(String)
method BuildGrepScript #
BuildGrepScript(String)