Extensions

Full name SMRUCC.genomics.Visualize.Circos.Configurations.Extensions Assembly SMRUCC.genomics.Visualize.Circos.Core Members 9

01 Syntax

SMRUCC.genomics.Visualize.Circos.Configurations.Extensions

02 Methods

Name	Overloads	Summary
CircosOption	1	CircosAPI.yes, CircosAPI.no
Num	2	将数值格式化为 circos 配置文件之中可以被正确解析的字符串值
GenerateConfigLines	1	从 SimpleConfig 特性标记的属性生成 circos 配置文件的参数行
HasValue	1	判断配置行是否携带了有效的参数值
BuildCircosBlock	1	生成一个 circos 的顶层配置块(<plots> / <links> / <highlights>)
GenerateCircosDocumentElement	1	Generates the docuemtn text data for write circos file.
GenerateConfigLines	1
GenerateCircosDocumentElement	1

03 Members

method CircosOption #

CircosOption(Boolean)

CircosAPI.yes, CircosAPI.no

Parameters

Name	Type	Description
`b`	`Boolean`	-

method Num #

Num(Double)

将数值格式化为 circos 配置文件之中可以被正确解析的字符串值

Remarks

circos 是一个 perl 程序，其只能够接受小数点作为小数分隔符，所以在这里必须使用 CultureInfo.InvariantCulture，不可以直接使用 VB 之中的 CStr 运算符（在德语、简体中文等 locale 之下会输出例如 0,5 这样的非法数值，导致 circos 解析失败）

Parameters

Name	Type	Description
`value`	`Double`	-

method Num overload 2 #

Num(Int32)

将数值格式化为 circos 配置文件之中可以被正确解析的字符串值

Parameters

Name	Type	Description
`value`	`Int32`	-

method GenerateConfigLines #

GenerateConfigLines``1(``0, Boolean)

从 SimpleConfig 特性标记的属性生成 circos 配置文件的参数行

Type Parameters

Name	Description
`T`	请使用具体的类型，而不是基类型，否则反射只能够取到基类之中的属性集合

Parameters

Name	Type	Description
`target`	``0	-
`skipEmpty`	`Boolean`	是否跳过值为空的属性行？默认为真。 (`SimpleConfig.GenerateConfigurations` 会原样输出所有的属性，包括那些值为空的属性，这会生成类似于 `genome =` 这样的垃圾参数行)

method HasValue #

HasValue(String)

判断配置行是否携带了有效的参数值

Parameters

Name	Type	Description
`line`	`String`	`name = value` 格式的配置参数行

method BuildCircosBlock #

BuildCircosBlock(String, IEnumerable(Of ICircosDocNode), String)

生成一个 circos 的顶层配置块(<plots> / <links> / <highlights>)

Parameters

Name	Type	Description
`name`	`String`	顶层块的名称，仅可以为 plots、links 或者 highlights
`nodes`	`IEnumerable(Of ICircosDocNode)`	被放置在这个顶层块之中的子元素
`directory`	`String`	The root directory of `circos.conf` file.

Returns

当子元素列表为空的时候返回空字符串，表示不需要输出这个块

method GenerateCircosDocumentElement #

GenerateCircosDocumentElement``1(``0, String, Int32, IEnumerable(Of ICircosDocNode), String)

Generates the docuemtn text data for write circos file.

Type Parameters

Name	Description
`T`

Parameters

Name	Type	Description
`data`	``0	-
`Tag`	`String`	-
`IndentLevel`	`Int32`	-
`inserts`	`IEnumerable(Of ICircosDocNode)`	-

method GenerateConfigLines #

GenerateConfigLines(T, Boolean)

method GenerateCircosDocumentElement #

GenerateCircosDocumentElement(T, String, Int32, IEnumerable(Of ICircosDocNode), String)