rcsb saguaro下載 - rcsb saguaro原始碼下載

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"
} ) ;

請在此處在線查看此擴展示例

rcsb-saguaro-應用程序

我們也提供了一個函式庫 (rcsb-saguaro-app) 來建立 RCSB PDB 和 UniProtKB 註解的預先配置一維蛋白質特徵視圖。

貢獻

歡迎所有貢獻。請提出拉取請求或提出問題。

執照

麻省理工學院許可證

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

特此免費授予任何獲得本軟體和相關文件文件（「軟體」）副本的人不受限制地使用本軟體，包括但不限於使用、複製、修改、合併的權利、發布、分發、再授權和/或銷售軟體的副本，並允許向其提供軟體的人員這樣做，但須滿足以下條件：

本軟體以「現況」提供，不提供任何明示或暗示的保證，包括但不限於適銷性、特定用途的適用性和不侵權的保證。 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE軟體.

展開

附加信息