rcsb saguaro

rcsb-saguaro

RCSB Saguaro 1D Feature Viewer é uma biblioteca TypeScript de código aberto usada para exibir anotações de proteínas e sequências genômicas na web. O projeto é desenvolvido e mantido no RCSB PDB e atualmente é utilizado para exibir recursos de proteínas em seu site. O pacote oferece vários tipos de exibição de dados e um rico conjunto de opções para personalizar a visualização de recursos.

Ao usar rcsb-saguaro, cite:

Joan Segura, Yana Rose, John Westbrook, Stephen K Burley, Jose M Duarte. Ferramentas e serviços 1D do RCSB Protein Data Bank, Bioinformática, 2020; https://doi.org/10.1093/bioinformatics/btaa1012

Instalação do módulo de nó

npm install @rcsb/rcsb-saguaro

Teste

Diferentes exemplos de testes estão disponíveis na pasta src/examples

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

Vá para:

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

JavaScript da CDN

Documentação da Biblioteca

A documentação completa das classes TypeScript pode ser encontrada aqui.

Principais classes e interfaces

Estes são os elementos mais importantes se você estiver interessado apenas em usar o RCSB Saguaro para visualizar anotações de proteínas

• RcsbFv: Classe principal do visualizador de recursos que pode ser usada para criar, configurar e renderizar um objeto visualizador de recursos. Inclui diferentes métodos para alterar a configuração do visualizador, adicionar novas trilhas, substituir ou atualizar dados da trilha ou alterar a visibilidade da trilha
• RcsbFvBoardConfigInterface: interface de configuração do visualizador de recursos que define as diferentes propriedades para configurar o painel principal do visualizador de recursos, incluindo título da trilha e largura das células de anotação, ativação do sinalizador de dicas de ferramentas e clique de anotação e retornos de chamada flutuantes
• RcsbFvRowConfigInterface: Esta interface pode ser usada para definir a configuração das trilhas do visualizador de recursos. Inclui múltiplas propriedades que definem como os recursos da trilha são exibidos (cor, forma, sinalizador de sobreposição) e também diferentes atributos da trilha (cor de fundo, altura da trilha, título da trilha, visibilidade da trilha)
• RcsbFvTrackDataElementInterface Interface que define propriedades de um objeto de anotação específico. Inclui o local onde a anotação será exibida (início, fim) e propriedades adicionais para alterar a representação final e o comportamento do evento de clique

Quadro Geral e Configuração de Pista

Configuração da placa

A configuração principal do objeto do painel do visualizador define o intervalo de coordenadas, a largura da trilha e do título e a exibição do eixo. O conjunto completo de atributos é definido na interface RcsbFvBoardConfigInterface.

As propriedades de configuração da placa principal são:

• intervalo : objeto que define o segmento de coordenadas do domínio 1D como um intervalo de valores inteiros sequenciais
  • min : Valor numérico que define a posição inicial das coordenadas
  • max : Valor numérico que define a posição final das coordenadas
• trackWidth : valor numérico que define a largura das células do quadro que contém o recurso
• rowTitleWidth : valor numérico que define a largura das células do título da linha
• includeAxis : Sinalizador booleano usado para incluir um eixo horizontal 1D na parte superior do quadro

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

Configuração de rastreamento

O objeto de configuração de linha define o formato e o conteúdo das linhas do visualizador de recursos. O conjunto completo de atributos de configuração de linha da placa é definido em RcsbFvRowConfigInterface.

As propriedades de configuração da linha principal são:

• trackHeight : Define a altura da linha do quadro
• trackColor : Cor na qual os dados da linha serão exibidos
• rowTitle : título da faixa do quadro, texto exibido próximo à linha do quadro
• displayType : valor enumerado usado para definir como os dados são exibidos
  • Valores: sequência, bloco, pino, linha, área, vínculo, vline
• trackData : lista de dados exibidos na linha do quadro. O conjunto completo de atributos de dados é definido em RcsbFvTrackDataElementInterface. Os atributos dos elementos de dados mais importantes são
  • começar : Posição inicial do recurso
  • end : Posição final do recurso (valor opcional). Quando nenhum valor final está disponível, o recurso está localizado em uma única posição definida por start
  • value : valor numérico ou string do recurso neste intervalo (valor opcional)
  • gaps : lista de regiões vazias no recurso. Estas regiões são exibidas como uma linha tracejada entre os blocos. Este atributo só está disponível quando displayType é "block"
    • Atributos: início, fim

Rastrear exemplos de configuração

• Trilha de sequência

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

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

• Bloquear trilha

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

Construtor de visualização de recursos

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

Veja este exemplo expandido online aqui

Mais exemplos

• Faixas únicas
• Faixa Composta
• Faixas Dinâmicas
• Visibilidade da trilha
• Atualizar dados da trilha
• Clique em retorno de chamada

A coleção completa de exemplos pode ser editada e modificada no CODEPEN

aplicativo rcsb-saguaro

Também fornecemos uma biblioteca (rcsb-saguaro-app) para construir visualizações de recursos de proteína 1D pré-configuradas de anotações RCSB PDB e UniProtKB.

Contribuindo

Todas as contribuições são bem-vindas. Por favor, faça uma solicitação pull ou abra um problema.

Licença

A licença do MIT

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

É concedida permissão, gratuitamente, a qualquer pessoa que obtenha uma cópia deste software e dos arquivos de documentação associados (o "Software"), para negociar o Software sem restrições, incluindo, sem limitação, os direitos de usar, copiar, modificar, mesclar , publicar, distribuir, sublicenciar e/ou vender cópias do Software e permitir que as pessoas a quem o Software seja fornecido o façam, sujeito às seguintes condições:

O aviso de direitos autorais acima e este aviso de permissão serão incluídos em todas as cópias ou partes substanciais do Software.

O SOFTWARE É FORNECIDO "COMO ESTÁ", SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU IMPLÍCITA, INCLUINDO, MAS NÃO SE LIMITANDO ÀS GARANTIAS DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UM DETERMINADO FIM E NÃO VIOLAÇÃO. EM NENHUM CASO OS AUTORES OU DETENTORES DE DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER RECLAMAÇÃO, DANOS OU OUTRA RESPONSABILIDADE, SEJA EM UMA AÇÃO DE CONTRATO, ATO ILÍCITO OU DE OUTRA FORMA, DECORRENTE DE, OU EM CONEXÃO COM O SOFTWARE OU O USO OU OUTRAS NEGOCIAÇÕES NO SOFTWARE.