rcsb saguaro

RCSB-仙人掌

RCSB Saguaro 1D Feature Viewer 是一个开源 TypeScript 库，用于通过网络显示蛋白质和基因组序列注释。该项目由 RCSB PDB 开发和维护，目前用于在其网站上显示蛋白质特征。该软件包提供多种类型的数据显示和一组丰富的选项来自定义特征可视化。

使用 rcsb-saguaro 时，请引用：

琼·塞古拉、雅娜·罗斯、约翰·威斯布鲁克、斯蒂芬·K·伯利、何塞·M·杜阿尔特。 RCSB 蛋白质数据库一维工具和服务，生物信息学，2020； https://doi.org/10.1093/bioinformatics/btaa1012

节点模块安装

npm install @rcsb/rcsb-saguaro

测试

src/examples文件夹中提供了不同的测试示例

• git clone [email protected]:rcsb/rcsb-saguaro.git
• cd rcsb-saguaro
• npm install
• npm run devServer

前往：

• http://localhost:9000/MultipleTracks.html
• http://localhost:9000/MultipleAlignment.html

CDN JavaScript

库文档

TypeScript 完整的类文档可以在这里找到。

主要类和接口

如果您只对使用 RCSB Saguaro 可视化蛋白质注释感兴趣，那么这些是最重要的元素

• RcsbFv：主要要素查看器类，可用于创建、配置和渲染要素查看器对象。它包括更改查看器配置、添加新轨道、替换或更新轨道数据或更改轨道可见性的不同方法
• RcsbFvBoardConfigInterface：功能查看器配置接口，定义不同的属性来配置功能查看器主面板，包括轨道标题和注释单元格宽度、激活工具提示标志和注释单击和悬停回调
• RcsbFvRowConfigInterface：此接口可用于设置功能查看器轨道的配置。它包括定义轨道特征如何显示的多个属性（颜色、形状、重叠标志）以及不同的轨道属性（背景颜色、轨道高度、轨道标题、轨道可见性）
• RcsbFvTrackDataElementInterface 定义特定注释对象属性的接口。它包括注释显示的位置（开始、结束）以及用于更改最终表示和单击事件行为的其他属性

通用板和轨道配置

主板配置

主要功能查看器板对象配置定义了坐标范围、轨道和标题宽度以及轴显示。完整的属性集在 RcsbFvBoardConfigInterface 接口中定义。

主板配置属性有：

• range ：将一维域坐标段定义为一系列连续整数值的对象
  • min ：定义坐标起始位置的数值
  • max ：定义坐标结束位置的数值
• trackWidth ：定义包含该功能的板单元宽度的数值
• rowTitleWidth ：定义行标题单元格宽度的数值
• includeAxis ：用于在板顶部包含一维水平轴的布尔标志

 const boardConfig = {
    range : {
        min : 20 ,
        max : 110
    } ,
    trackWidth : 940 ,
    rowTitleWidth : 260 ,
    includeAxis : true
} ; 

轨道配置

行配置对象定义要素查看器行的格式和内容。完整的板行配置属性集在 RcsbFvRowConfigInterface 中定义。

主行配置属性为：

• trackHeight ：定义板行高度
• trackColor ：显示行数据的颜色
• rowTitle ：板轨道标题，板行旁边显示的文本
• displayType ：用于定义数据显示方式的枚举值
  • 值：序列、块、引脚、线、面积、键、vline
• trackData ：板行中显示的数据列表。完整的数据属性集在 RcsbFvTrackDataElementInterface 中定义。最重要的数据元素属性是
  • begin : 特征的开始位置
  • end ：特征的结束位置（可选值）。当没有可用的结束值时，该特征位于由开始定义的单个位置
  • value ：该范围内特征的数字或字符串值（可选值）
  • 差距：特征中的空白区域列表。这些区域显示为块之间的虚线。该属性仅当displayType为“block”时可用
    • 属性：开始、结束

轨道配置示例

• 序列轨道

 const sequence = "MTEYKLVVVGAGGVGKSALTIQLIQNHFVDEYDPTIEDSYRKQVVIDGETCLLDILDTAGQ" +
                 "EEYSAMRDQYMRTGEGFLCVFAINNTKSFEDIHQYREQIKRVKDSDDVPMVLVGNKCDLAA" +
                 "RTVESRQAQDLARSYGIPYIETSAKTRQGVEDAFYTLVREIRQHKLRKLNPPDESGPGCMS" 

 const sequenceTrack = {
    trackHeight : 20 ,
    trackColor : "#F9F9F9" ,
    displayType : "sequence" ,
    rowTitle : "SEQUENCE" ,
    trackData : [ {
        begin : 1 ,
        label : sequence
    } ]
}

• 块轨道

 const blockTrack = {
    trackId : "blockTrack" ,
    trackHeight : 20 ,
    trackColor : "#F9F9F9" ,
    displayType : "block" ,
    displayColor : "#FF0000" ,
    rowTitle : "BLOCK" ,
    trackData : [ {
        begin : 30 ,
        end : 60 ,
        gaps : [ {
            begin : 40 ,
            end : 50
        } ]
    } , {
        begin : 80 ,
        end : 90 ,
        openEnd : true
    } ]
} 

特征视图构造函数

 const pfv = new RcsbFv . Create ( {
    boardConfigData : boardConfig ,
    rowConfigData : [ sequenceTrack , blockTrack ] ,
    elementId : "htmlElementId"
} ) ;

请在此处在线查看此扩展示例

更多示例

• 单轨
• 复合跑道
• 动态轨道
• 轨道可见性
• 更新轨迹数据
• 点击回拨

完整的示例集合可以在 CODEPEN 进行编辑和修改

rcsb-saguaro-应用程序

我们还提供了一个库 (rcsb-saguaro-app) 来构建 RCSB PDB 和 UniProtKB 注释的预配置一维蛋白质特征视图。

贡献

欢迎所有贡献。请提出拉取请求或提出问题。

执照

麻省理工学院许可证

 Copyright (c) 2019 - now, RCSB PDB and contributors

特此免费授予获得本软件和相关文档文件（“软件”）副本的任何人不受限制地使用本软件，包括但不限于使用、复制、修改、合并的权利、发布、分发、再许可和/或销售软件的副本，并允许向其提供软件的人员这样做，但须满足以下条件：

上述版权声明和本许可声明应包含在本软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、特定用途的适用性和不侵权的保证。在任何情况下，作者或版权持有者均不对因本软件或本软件中的使用或其他交易而产生或与之相关的任何索赔、损害或其他责任负责，无论是合同、侵权行为还是其他行为。软件。