rcsb saguaro

rcsb-saguaro

RCSB Saguaro 1D Feature Viewer adalah pustaka TypeScript sumber terbuka yang digunakan untuk menampilkan anotasi urutan protein dan genom melalui web. Proyek ini dikembangkan dan dipelihara di RCSB PDB dan saat ini digunakan untuk menampilkan fitur protein di situs webnya. Paket ini menawarkan berbagai jenis tampilan data dan serangkaian opsi untuk menyesuaikan visualisasi fitur.

Saat menggunakan rcsb-saguaro, harap kutip:

Joan Segura, Yana Rose, John Westbrook, Stephen K Burley, Jose M Duarte. Alat dan layanan 1D RCSB Protein Data Bank, Bioinformatika, 2020; https://doi.org/10.1093/bioinformatics/btaa1012

Instalasi Modul Node

npm install @rcsb/rcsb-saguaro

Pengujian

Contoh pengujian yang berbeda tersedia di folder src/examples

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

Kunjungi:

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

JavaScript CDN

Dokumentasi Perpustakaan

Dokumentasi kelas lengkap TypeScript dapat ditemukan di sini.

Kelas Utama dan Antarmuka

Ini adalah elemen terpenting jika Anda hanya tertarik menggunakan RCSB Saguaro untuk memvisualisasikan anotasi protein

• RcsbFv: Kelas penampil fitur utama yang dapat digunakan untuk membuat, mengonfigurasi, dan merender objek penampil fitur. Ini mencakup berbagai metode untuk mengubah konfigurasi penampil, menambahkan trek baru, mengganti atau memperbarui data trek, atau mengubah visibilitas trek
• RcsbFvBoardConfigInterface: Antarmuka konfigurasi penampil fitur yang menentukan properti berbeda untuk mengonfigurasi panel utama penampil fitur termasuk judul trek dan lebar sel anotasi, mengaktifkan tanda tooltips dan klik anotasi serta panggilan balik yang melayang
• RcsbFvRowConfigInterface: Antarmuka ini dapat digunakan untuk mengatur konfigurasi trek penampil fitur. Ini mencakup beberapa properti yang menentukan bagaimana fitur trek ditampilkan (warna, bentuk, bendera yang tumpang tindih) dan juga atribut trek yang berbeda (warna latar belakang, tinggi trek, judul trek, visibilitas trek)
• RcsbFvTrackDataElementInterface Antarmuka yang mendefinisikan properti objek anotasi tertentu. Ini mencakup lokasi di mana anotasi akan ditampilkan (mulai, akhir) dan properti tambahan untuk mengubah representasi akhir dan perilaku peristiwa klik

Konfigurasi Papan dan Jalur Umum

Konfigurasi Papan

Konfigurasi objek papan penampil fitur utama menentukan rentang koordinat, lebar trek dan judul, serta tampilan sumbu. Kumpulan atribut lengkap ditentukan di antarmuka RcsbFvBoardConfigInterface.

Properti Konfigurasi Papan Utama adalah:

• range : Objek yang mendefinisikan segmen koordinat domain 1D sebagai rentang nilai bilangan bulat berurutan
  • min : Nilai numerik yang menentukan posisi awal koordinat
  • max : Nilai numerik yang menentukan posisi akhir koordinat
• trackWidth : Nilai numerik yang menentukan lebar sel papan yang berisi fitur tersebut
• rowTitleWidth : Nilai numerik yang menentukan lebar sel judul baris
• includeAxis : Bendera Boolean yang digunakan untuk menyertakan sumbu horizontal 1D di bagian atas papan

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

Konfigurasi Lacak

Objek konfigurasi baris menentukan format dan konten baris penampil fitur. Kumpulan lengkap atribut konfigurasi baris papan ditentukan di RcsbFvRowConfigInterface.

Properti Konfigurasi Baris Utama adalah:

• trackHeight : Mendefinisikan tinggi baris papan
• trackColor : Warna di mana data baris akan ditampilkan
• rowTitle : Judul trek papan, teks ditampilkan di sebelah baris papan
• displayType : Nilai yang disebutkan yang digunakan untuk menentukan bagaimana data ditampilkan
  • Nilai: barisan, balok, pin, garis, luas, ikatan, vline
• trackData : Daftar data yang ditampilkan di baris papan. Kumpulan lengkap atribut data ditentukan di RcsbFvTrackDataElementInterface. Atribut elemen data yang paling penting adalah
  • mulai : Posisi awal fitur
  • end : Posisi akhir fitur (nilai opsional). Ketika tidak ada nilai akhir yang tersedia, fitur tersebut terletak pada satu posisi yang ditentukan oleh awal
  • value : Nilai numerik atau string fitur dalam rentang ini (nilai opsional)
  • gaps : Daftar wilayah kosong di fitur. Wilayah ini ditampilkan sebagai garis putus-putus antar blok. Atribut ini hanya tersedia ketika displayType adalah "block"
    • Atribut: mulai, akhir

Contoh Konfigurasi Lacak

• Jalur Urutan

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

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

• Blokir Jalur

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

Konstruktor Tampilan Fitur

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

Lihat contoh yang diperluas ini secara online di sini

Contoh Lainnya

• Trek Tunggal
• Jalur Komposit
• Trek Dinamis
• Visibilitas Lacak
• Perbarui Data Lintasan
• Klik Panggilan Balik

Kumpulan contoh lengkap dapat diedit dan dimodifikasi di CODEPEN

rcsb-saguaro-app

Kami juga menyediakan perpustakaan (rcsb-saguaro-app) untuk membuat Tampilan Fitur Protein 1D yang telah dikonfigurasi sebelumnya dari anotasi RCSB PDB dan UniProtKB.

Berkontribusi

Semua kontribusi dipersilakan. Silakan, buat permintaan tarik atau buka masalah.

Lisensi

Lisensi MIT

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

Izin dengan ini diberikan, secara gratis, kepada siapa pun yang memperoleh salinan perangkat lunak ini dan file dokumentasi terkait ("Perangkat Lunak"), untuk menggunakan Perangkat Lunak tanpa batasan, termasuk tanpa batasan hak untuk menggunakan, menyalin, memodifikasi, menggabungkan , mempublikasikan, mendistribusikan, mensublisensikan, dan/atau menjual salinan Perangkat Lunak, dan mengizinkan orang yang menerima Perangkat Lunak untuk melakukan hal tersebut, dengan tunduk pada ketentuan berikut:

Pemberitahuan hak cipta di atas dan pemberitahuan izin ini akan disertakan dalam semua salinan atau sebagian besar Perangkat Lunak.

PERANGKAT LUNAK INI DISEDIAKAN "APA ADANYA", TANPA JAMINAN APA PUN, TERSURAT MAUPUN TERSIRAT, TERMASUK NAMUN TIDAK TERBATAS PADA JAMINAN KELAYAKAN UNTUK DIPERDAGANGKAN, KESESUAIAN UNTUK TUJUAN TERTENTU, DAN TIDAK ADA PELANGGARAN. DALAM KEADAAN APA PUN PENULIS ATAU PEMEGANG HAK CIPTA TIDAK BERTANGGUNG JAWAB ATAS KLAIM, KERUSAKAN ATAU TANGGUNG JAWAB LAINNYA, BAIK DALAM TINDAKAN KONTRAK, HUKUM ATAU LAINNYA, YANG TIMBUL DARI, DARI ATAU SEHUBUNGAN DENGAN PERANGKAT LUNAK ATAU PENGGUNAAN ATAU HAL-HAL LAIN DALAM PERANGKAT LUNAK.