rcsb saguaro

rcsb-сагуаро

RCSB Saguaro 1D Feature Viewer — это библиотека TypeScript с открытым исходным кодом, используемая для отображения аннотаций белков и геномных последовательностей через Интернет. Проект разрабатывается и поддерживается в RCSB PDB и в настоящее время используется для отображения свойств белка на его веб-сайте. Пакет предлагает несколько типов отображения данных и богатый набор опций для настройки визуализации функций.

При использовании rcsb-saguaro указывайте:

Джоан Сегура, Яна Роуз, Джон Уэстбрук, Стивен К. Берли, Хосе М. Дуарте. Инструменты и услуги RCSB Protein Data Bank 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 JavaScript

Библиотечная документация

Полную документацию по классам TypeScript можно найти здесь.

Основные классы и интерфейсы

Это наиболее важные элементы, если вас интересует использование RCSB Saguaro только для визуализации аннотаций белков.

• RcsbFv: основной класс средства просмотра объектов, который можно использовать для создания, настройки и визуализации объекта просмотра объектов. Он включает в себя различные методы изменения конфигурации средства просмотра, добавления новых треков, замены или обновления данных трека или изменения видимости трека.
• RcsbFvBoardConfigInterface: интерфейс конфигурации средства просмотра функций, который определяет различные свойства для настройки главной панели средства просмотра объектов, включая ширину заголовка и ячеек аннотаций, активацию флага всплывающих подсказок, а также щелчок аннотации и обратные вызовы при наведении.
• RcsbFvRowConfigInterface: этот интерфейс можно использовать для настройки конфигурации треков просмотра функций. Он включает в себя несколько свойств, определяющих способ отображения объектов трека (цвет, форма, флаг перекрытия), а также различные атрибуты трека (цвет фона, высота трека, название трека, видимость трека).
• RcsbFvTrackDataElementInterface Интерфейс, определяющий свойства конкретного объекта аннотации. Он включает в себя место, где будет отображаться аннотация (начало, конец), а также дополнительные свойства для изменения окончательного представления и поведения события щелчка.

Общая конфигурация платы и трека

Конфигурация платы

Основная функция конфигурации объекта доски просмотра определяет диапазон координат, ширину дорожки и заголовка, а также отображение осей. Полный набор атрибутов определен в интерфейсе RcsbFvBoardConfigInterface.

Свойства конфигурации основной платы:

• диапазон : объект, который определяет сегмент координат 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 : перечислимое значение, используемое для определения способа отображения данных.
  • Значения: последовательность, блок, контакт, линия, область, связь, vline.
• trackData : список данных, отображаемых в строке доски. Полный набор атрибутов данных определен в RcsbFvTrackDataElementInterface. Наиболее важными атрибутами элементов данных являются
  • начало : Начальная позиция объекта.
  • end : Конечная позиция объекта (необязательное значение). Если конечное значение недоступно, объект располагается в одной позиции, определенной параметром Begin.
  • 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-сагуаро-приложение

Мы также предоставляем библиотеку (rcsb-saguaro-app) для создания предварительно настроенных одномерных представлений функций белков для аннотаций RCSB PDB и UniProtKB.

Содействие

Все вклады приветствуются. Пожалуйста, сделайте запрос на включение или откройте проблему.

Лицензия

Лицензия MIT

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

Настоящим бесплатно любому лицу, получившему копию этого программного обеспечения и связанных с ним файлов документации («Программное обеспечение»), предоставляется разрешение на работу с Программным обеспечением без ограничений, включая, помимо прочего, права на использование, копирование, изменение, объединение. публиковать, распространять, сублицензировать и/или продавать копии Программного обеспечения, а также разрешать лицам, которым предоставлено Программное обеспечение, делать это при соблюдении следующих условий:

Вышеупомянутое уведомление об авторских правах и данное уведомление о разрешении должны быть включены во все копии или существенные части Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ, ГАРАНТИЯМИ ТОВАРНОЙ ЦЕННОСТИ, ПРИГОДНОСТИ ДЛЯ ОПРЕДЕЛЕННОЙ ЦЕЛИ И НЕНАРУШЕНИЯ ПРАВ. НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ АВТОРЫ ИЛИ ОБЛАДАТЕЛИ АВТОРСКИХ ПРАВ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УБЫТКИ ИЛИ ДРУГУЮ ОТВЕТСТВЕННОСТЬ, БУДЬ В ДЕЙСТВИЯХ ПО КОНТРАКТУ, ПРАВОНАРУШЕНИЮ ИЛИ ДРУГИМ ОБРАЗОМ, ВОЗНИКАЮЩИЕ ОТ, ИЗ ИЛИ В СВЯЗИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ДРУГИМИ СДЕЛКАМИ, ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ.