rcsb saguaro

rcsb-saguaro

RCSB Saguaro 1D Feature Viewer es una biblioteca TypeScript de código abierto que se utiliza para mostrar anotaciones de secuencias genómicas y de proteínas en la web. El proyecto se desarrolla y mantiene en RCSB PDB y actualmente se utiliza para mostrar características de proteínas en su sitio web. El paquete ofrece múltiples tipos de visualización de datos y un amplio conjunto de opciones para personalizar la visualización de funciones.

Cuando utilice rcsb-saguaro, cite:

Joan Segura, Yana Rose, John Westbrook, Stephen K Burley, José M Duarte. Herramientas y servicios 1D del RCSB Protein Data Bank, Bioinformática, 2020; https://doi.org/10.1093/bioinformatics/btaa1012

Instalación del módulo de nodo

npm install @rcsb/rcsb-saguaro

Pruebas

Hay diferentes ejemplos de prueba disponibles en la carpeta src/examples

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

Ir a:

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

JavaScript CDN

Documentación de la biblioteca

La documentación completa de las clases de TypeScript se puede encontrar aquí.

Principales clases e interfaces

Estos son los elementos más importantes si solo estás interesado en utilizar RCSB Saguaro para visualizar anotaciones de proteínas.

• RcsbFv: clase de visor de características principal que se puede usar para crear, configurar y representar un objeto de visor de características. Incluye diferentes métodos para cambiar la configuración del visor, agregar nuevas pistas, reemplazar o actualizar datos de la pista o cambiar la visibilidad de la pista.
• RcsbFvBoardConfigInterface: interfaz de configuración del visor de funciones que define las diferentes propiedades para configurar el panel principal del visor de funciones, incluido el título de la pista y el ancho de las celdas de anotación, activar la bandera de información sobre herramientas y hacer clic en las anotaciones y devoluciones de llamada al pasar el mouse.
• RcsbFvRowConfigInterface: esta interfaz se puede utilizar para configurar la configuración de las pistas del visor de funciones. Incluye múltiples propiedades que definen cómo se muestran las características de la pista (color, forma, bandera de superposición) y también diferentes atributos de la pista (color de fondo, altura de la pista, título de la pista, visibilidad de la pista).
• RcsbFvTrackDataElementInterface Interfaz que define las propiedades de un objeto de anotación específico. Incluye la ubicación donde se mostrará la anotación (inicio, final) y propiedades adicionales para cambiar la representación final y el comportamiento del evento de clic.

Configuración general de placa y pista

Configuración de la placa

La configuración del objeto del tablero del visor de características principales define el rango de coordenadas, la pista y el ancho del título y la visualización del eje. El conjunto completo de atributos se define en la interfaz RcsbFvBoardConfigInterface.

Las propiedades de configuración de la placa principal son:

• rango : Objeto que define el segmento de coordenadas del dominio 1D como un rango de valores enteros secuenciales
  • min : Valor numérico que define la posición inicial de las coordenadas.
  • max : Valor numérico que define la posición final de las coordenadas
• trackWidth : Valor numérico que define el ancho de las celdas del tablero que contiene la característica
• rowTitleWidth : Valor numérico que define el ancho de las celdas del título de la fila
• includeAxis : bandera booleana utilizada para incluir un eje horizontal 1D en la parte superior del tablero

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

Configuración de seguimiento

El objeto de configuración de filas define el formato y el contenido de las filas del visor de funciones. El conjunto completo de atributos de configuración de filas de la placa se define en RcsbFvRowConfigInterface.

Las propiedades de configuración de la fila principal son:

• trackHeight : define la altura de la fila del tablero.
• trackColor : Color en el que se mostrarán los datos de la fila
• rowTitle : título de la pista del tablero, texto que se muestra junto a la fila del tablero
• displayType : valor enumerado utilizado para definir cómo se muestran los datos
  • Valores: secuencia, bloque, pin, línea, área, enlace, vline
• trackData : Lista de datos que se muestran en la fila del tablero. El conjunto completo de atributos de datos se define en RcsbFvTrackDataElementInterface. Los atributos de los elementos de datos más importantes son
  • comenzar : posición inicial de la función
  • end : Posición final de la característica (valor opcional). Cuando no hay un valor final disponible, la función se ubica en una única posición definida por inicio
  • valor : valor numérico o de cadena de la característica en este rango (valor opcional)
  • huecos : Lista de regiones vacías en la característica. Estas regiones se muestran como una línea discontinua entre bloques. Este atributo solo está disponible cuando displayType es "bloque"
    • Atributos: comienzo, fin

Ejemplos de configuración de pistas

• Pista de secuencia

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

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

• Pista de bloque

 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
    } ]
} 

Constructor de vista de características

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

Vea este ejemplo ampliado en línea aquí

Más ejemplos

• Pistas individuales
• Pista compuesta
• Pistas dinámicas
• Visibilidad de seguimiento
• Actualizar datos de seguimiento
• Haga clic en Devolución de llamada

La colección completa de ejemplos se puede editar y modificar en CODEPEN

aplicación-rcsb-saguaro

También proporcionamos una biblioteca (rcsb-saguaro-app) para crear vistas de características de proteínas 1D preconfiguradas de anotaciones RCSB PDB y UniProtKB.

Contribuyendo

Todas las contribuciones son bienvenidas. Por favor, haga una solicitud de extracción o abra un problema.

Licencia

La licencia MIT

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

Por el presente se otorga permiso, sin cargo, a cualquier persona que obtenga una copia de este software y los archivos de documentación asociados (el "Software"), para operar con el Software sin restricciones, incluidos, entre otros, los derechos de uso, copia, modificación, fusión. , publicar, distribuir, sublicenciar y/o vender copias del Software, y permitir que las personas a quienes se les proporciona el Software lo hagan, sujeto a las siguientes condiciones:

El aviso de derechos de autor anterior y este aviso de permiso se incluirán en todas las copias o partes sustanciales del Software.

EL SOFTWARE SE PROPORCIONA "TAL CUAL", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O IMPLÍCITA, INCLUYENDO, PERO NO LIMITADO A, LAS GARANTÍAS DE COMERCIABILIDAD, IDONEIDAD PARA UN PROPÓSITO PARTICULAR Y NO INFRACCIÓN. EN NINGÚN CASO LOS AUTORES O TITULARES DE DERECHOS DE AUTOR SERÁN RESPONSABLES DE NINGÚN RECLAMO, DAÑO U OTRA RESPONSABILIDAD, YA SEA EN UNA ACCIÓN CONTRACTUAL, AGRAVIO O DE OTRA MANERA, QUE SURJA DE, FUERA DE O EN RELACIÓN CON EL SOFTWARE O EL USO U OTRAS NEGOCIOS EN EL SOFTWARE.