rcsb saguaro

rcsb-saguaro

RCSB Saguaro 1D Feature Viewer는 웹을 통해 단백질 및 게놈 서열 주석을 표시하는 데 사용되는 오픈 소스 TypeScript 라이브러리입니다. 이 프로젝트는 RCSB PDB에서 개발 및 유지 관리되며 현재 웹 사이트에 단백질 기능을 표시하는 데 사용됩니다. 이 패키지는 다양한 유형의 데이터 표시와 기능 시각화를 사용자 정의할 수 있는 다양한 옵션 세트를 제공합니다.

rcsb-saguaro를 사용할 때 다음을 인용하십시오:

조안 세구라, 야나 로즈, 존 웨스트브룩, 스티븐 K 벌리, 호세 M 두아르테. RCSB 단백질 데이터 뱅크 1D 도구 및 서비스, 생물정보학, 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 자바스크립트

도서관 문서

TypeScript 전체 클래스 문서는 여기에서 찾을 수 있습니다.

주요 클래스와 인터페이스

RCSB Saguaro를 사용하여 단백질 주석을 시각화하는 데에만 관심이 있는 경우 이는 가장 중요한 요소입니다.

• RCsbFv: 기능 뷰어 개체를 생성, 구성 및 렌더링하는 데 사용할 수 있는 기본 기능 뷰어 클래스입니다. 여기에는 뷰어 구성 변경, 새 트랙 추가, 트랙 데이터 교체 또는 업데이트, 트랙 가시성 변경 등의 다양한 방법이 포함되어 있습니다.
• RcsbFvBoardConfigInterface: 트랙 제목 및 주석 셀 너비를 포함하여 기능 뷰어 기본 패널을 구성하고 도구 설명 플래그 및 주석 클릭 및 호버링 콜백을 활성화하는 다양한 속성을 정의하는 기능 뷰어 구성 인터페이스
• RCsbFvRowConfigInterface: 이 인터페이스는 기능 뷰어 트랙에 대한 구성을 설정하는 데 사용할 수 있습니다. 여기에는 트랙 기능이 표시되는 방식(색상, 모양, 겹침 플래그)과 다양한 트랙 속성(배경색, 트랙 높이, 트랙 제목, 트랙 가시성)을 정의하는 여러 속성이 포함되어 있습니다.
• 특정 주석 객체의 속성을 정의하는 RCsbFvTrackDataElementInterface 인터페이스입니다. 여기에는 주석이 표시될 위치(시작, 끝)와 최종 표현 및 클릭 이벤트 동작을 변경하기 위한 추가 속성이 포함됩니다.

일반 보드 및 트랙 구성

보드 구성

주요 기능 뷰어 보드 개체 구성은 좌표 범위, 트랙 및 제목 너비 및 축 표시를 정의합니다. 전체 속성 세트는 RcsbFvBoardConfigInterface 인터페이스에 정의되어 있습니다.

메인 보드 구성 속성은 다음과 같습니다.

• range : 1D 도메인 좌표 세그먼트를 순차적 정수 값의 범위로 정의하는 객체입니다.
  • min : 좌표 시작 위치를 정의하는 숫자값
  • max : 좌표 끝 위치를 정의하는 숫자 값
• trackWidth : 해당 기능이 포함된 보드 셀의 너비를 정의하는 숫자 값
• rowTitleWidth : 행 제목 셀의 너비를 정의하는 숫자 값
• includeAxis : 보드 상단에 1D 수평 축을 포함하는 데 사용되는 부울 플래그

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

트랙 구성

행 구성 개체는 기능 뷰어 행의 형식과 내용을 정의합니다. 보드 행 구성 속성의 전체 세트는 RcsbFvRowConfigInterface에 정의되어 있습니다.

기본 행 구성 속성은 다음과 같습니다.

• trackHeight : 보드 행 높이를 정의합니다.
• trackColor : 행 데이터가 표시될 색상
• rowTitle : 보드 트랙 제목, 보드 행 옆에 표시되는 텍스트
• displayType : 데이터 표시 방법을 정의하는 데 사용되는 열거형 값
  • 값: 시퀀스, 블록, 핀, 라인, 영역, 본드, V라인
• trackData : 보드 행에 표시되는 데이터 목록입니다. 전체 데이터 속성 세트는 RcsbFvTrackDataElementInterface에 정의되어 있습니다. 가장 중요한 데이터 요소 속성은 다음과 같습니다.
  • 시작 : 기능의 시작 위치
  • end : 기능의 끝 위치(선택적 값)입니다. 종료 값을 사용할 수 없는 경우 기능은 시작 으로 정의된 단일 위치에 위치합니다.
  • value : 이 범위에 있는 지형지물의 숫자 또는 문자열 값(선택적 값)
  • gaps : 지형지물의 빈 영역 목록입니다. 이러한 영역은 블록 사이에 점선으로 표시됩니다. 이 속성은 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 PDB 및 UniProtKB 주석의 사전 구성된 1D 단백질 기능 보기를 구축하기 위한 라이브러리(rcsb-saguaro-app)도 제공합니다.

기여

모든 기여를 환영합니다. 끌어오기 요청을 하거나 이슈를 열어주세요.

특허

MIT 라이센스

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

본 소프트웨어 및 관련 문서 파일("소프트웨어")의 사본을 취득한 모든 사람에게 사용, 복사, 수정, 병합에 대한 권리를 포함하되 이에 국한되지 않고 제한 없이 소프트웨어를 취급할 수 있는 권한이 무료로 부여됩니다. , 소프트웨어 사본을 게시, 배포, 재라이센스 부여 및/또는 판매하고, 소프트웨어를 제공받은 사람에게 다음 조건에 따라 그렇게 하도록 허용합니다.

위의 저작권 고지와 본 허가 고지는 소프트웨어의 모든 사본 또는 상당 부분에 포함됩니다.

소프트웨어는 상품성, 특정 목적에의 적합성 및 비침해에 대한 보증을 포함하되 이에 국한되지 않고 명시적이든 묵시적이든 어떠한 종류의 보증 없이 "있는 그대로" 제공됩니다. 어떠한 경우에도 작성자나 저작권 보유자는 계약, 불법 행위 또는 기타 행위로 인해 소프트웨어나 사용 또는 기타 거래와 관련하여 발생하는 모든 청구, 손해 또는 기타 책임에 대해 책임을 지지 않습니다. 소프트웨어.