bp_panalysis.plp - Online di Cloud

PROGRAM:

NAMA

panalysis.PLS - Contoh/skrip tutorial cara mengakses alat analisis

RINGKASAN

# jalankan analisis dengan urutan Anda dalam file lokal
./panalysis.PLS -n 'edit.seqret'-w -r \
sequence_direct_data=@/home/testdata/my.seq

Lihat lebih banyak contoh dalam teks di bawah ini.

DESKRIPSI

Klien yang menunjukkan cara menggunakan modul "Bio::Tools::Run::Analysis", modul untuk mengeksekusi dan
mengendalikan alat analisis lokal atau jarak jauh. Itu juga memanggil metode dari
Modul "Bio::Tools::Run::AnalysisFactory", modul yang menyediakan daftar analisis yang tersedia.

Terutama, klien ini dimaksudkan sebagai contoh bagaimana menggunakan modul analisis, dan juga untuk
menguji mereka. Namun, karena memiliki banyak opsi untuk mencakup sebanyak mungkin metode
mungkin, itu juga dapat digunakan sebagai klien baris perintah yang berfungsi penuh untuk mengakses
berbagai alat analisis.

Mendefinisikan tempat dan mengakses metode
"panalysis.PLS" tidak tergantung pada metode akses ke analisis jarak jauh (analisis
berjalan pada mesin yang berbeda). Metode yang digunakan untuk berkomunikasi dengan analisis adalah
ditentukan oleh opsi "-A", dengan nilai default sabun. Nilai lain yang mungkin (bukan
belum didukung, tetapi segera hadir) adalah Sup dan lokal.

Setiap metode akses mungkin memiliki arti yang berbeda untuk parameter "-l" yang mendefinisikan lokasi dari
layanan yang memberikan akses ke alat analisis. Misalnya, sabun akses mengharapkan URL
dari Layanan Web dalam opsi "-l", sementara Sup akses dapat menemukan di sini stringified
Referensi Objek Interoperable (IOR).

Lokasi default untuk sabun akses adalah "http://www.ebi.ac.uk/soaplab/services" yang
mewakili layanan yang berjalan di European Bioinformatics Institute di atas lebih dari seratus
Analisis EMBOSS (dan di atas beberapa lainnya).

Tersedia analisis
"panalysis.PLS" dapat menampilkan daftar analisis yang tersedia (dari lokasi yang diberikan menggunakan yang diberikan
metode akses). Opsi "-L" menunjukkan semua analisis, opsi "-c" mencantumkan semua yang tersedia
kategori (kategori adalah sekelompok analisis dengan fungsi atau pemrosesan yang serupa
jenis data yang serupa), dan akhirnya opsi "-C" hanya menampilkan analisis yang tersedia di dalam
kategori yang diberikan.

Perhatikan, bahwa semua fungsi ini disediakan oleh modul "Bio::Tools::Run::AnalysisFactory"
(masing-masing, oleh salah satu sub-kelas yang bergantung pada akses). Modul ini juga memiliki pabrik
metode "create_analysis" yang tidak digunakan oleh skrip ini.

Pelayanan
"Layanan" adalah tingkat abstraksi yang lebih tinggi dari alat analisis. Itu mengerti dengan baik
antarmuka yang ditentukan (modul "Bio::AnalysisI", sebuah fakta yang memungkinkan skrip ini menjadi
independen pada protokol akses ke berbagai layanan.

Nama layanan harus diberikan oleh opsi "-n". Opsi ini dapat dihilangkan hanya jika Anda
memanggil hanya metode "pabrik" (dijelaskan di atas).

Setiap layanan (mewakili alat analisis, program, atau aplikasi) memiliki
deskripsi, tersedia dengan menggunakan opsi "-a" (nama analisis, jenis, dll.), "-i", "-I"
(spesifikasi data input analisis, yang terpenting adalah namanya), dan "-o", "-O"
(nama hasil dan jenisnya). Opsi "-d" memberikan deskripsi paling rinci di
format XML.

Deskripsi layanannya bagus tetapi yang paling penting adalah menggunakan layanan untuk memanggil
alat analisis yang mendasarinya. Untuk setiap permintaan, layanan membuat "pekerjaan" dan memberinya umpan
dengan data masukan. Ada tiga tahap: (a) membuat pekerjaan, (b) menjalankan pekerjaan, dan (c) menunggu
untuk penyelesaiannya. Sejalan. ada tiga opsi: "-b" yang baru saja membuat
(membangun) pekerjaan, "-x" yang membuat pekerjaan dan menjalankannya, dan akhirnya "-w" yang
membuat pekerjaan, menjalankannya dan memblokir klien sampai pekerjaan selesai. Selalu hanya satu dari
opsi ini digunakan (jadi tidak masuk akal untuk menggunakan lebih banyak opsi, "panalysis.PLS"
memprioritaskan mereka dalam urutan "-x", "-w", dan "-b").

Semua opsi ini mengambil data input dari baris perintah (lihat bagian selanjutnya tentangnya) dan
semuanya mengembalikan (secara internal) objek yang mewakili pekerjaan. Ada banyak metode
(pilihan) berurusan dengan objek pekerjaan (lihat satu demi satu bagian berikutnya tentang mereka).

Catatan terakhir di bagian ini: opsi "-b" sebenarnya opsional - pekerjaan dibuat genap
tanpa opsi ini ketika ada beberapa data input yang ditemukan di baris perintah. Anda memiliki untuk
menggunakannya, namun, jika Anda tidak meneruskan data apa pun ke alat analisis (contohnya adalah
layanan "Klasik::HelloWorld" yang terkenal).

Memasukkan data
Data masukan diberikan sebagai pasangan nama/nilai, diletakkan pada baris perintah dengan tanda sama dengan antara
nama dan nilai. jika nilai bagian dimulai dengan karakter un-escaped "@", digunakan sebagai
nama file lokal dan "panalysis.PLS" membaca file dan menggunakan isinya sebagai gantinya.
contoh:

panalisis.PLS -n edit.seqret -w -r
sequence_direct_data='tatatctcccc' osformat=embl

analisis.PLS ...
sequence_direct_data=@/saya/data/saya.seq

Nama-nama data input berasal dari "spesifikasi input" yang dapat ditunjukkan oleh "-i"
atau opsi "-I". Spesifikasi input (saat menggunakan opsi "-I") juga menunjukkan - untuk beberapa
input - daftar nilai yang diizinkan. Namun, spesifikasinya tidak memberi tahu input apa
data saling eksklusif, atau batasan lain yang berlaku. Jika ada konflik,
pesan kesalahan dihasilkan kemudian (sebelum pekerjaan dimulai).

Data input digunakan ketika salah satu opsi "-b", "-x", atau "-w" ada, tetapi opsi
"-j" tidak ada (lihat bagian berikutnya tentang opsi pekerjaan ini).

Pekerjaan
Setiap layanan (didefinisikan dengan nama yang diberikan dalam opsi "-n") dapat dijalankan satu atau lebih
kali, dengan data yang sama, tetapi biasanya dengan input data yang berbeda. Setiap eksekusi menciptakan pekerjaan
obyek. Sebenarnya, pekerjaan dibuat bahkan sebelum eksekusi (ingat bahwa opsi "-b"
membangun pekerjaan tetapi belum menjalankannya).

Pekerjaan apa pun, dijalankan atau tidak, bersifat persisten dan dapat digunakan lagi nanti dari pekerjaan lain
pemanggilan skrip "panalysis.PLS". Kecuali Anda secara eksplisit menghancurkan pekerjaan menggunakan
opsi "-z".

Pekerjaan yang dibuat oleh opsi "-b", "-x" dan "-w" (dan dengan input data) dapat diakses di
doa "panalysis.PLS" yang sama menggunakan berbagai opsi terkait pekerjaan, yang paling penting adalah
"-r" dan "-R" untuk mengambil hasil dari pekerjaan yang sudah selesai.

Namun, Anda juga dapat membuat ulang pekerjaan yang dibuat oleh pemanggilan sebelumnya. Dengan asumsi bahwa Anda
tahu ID pekerjaan ("panalysis.PLS" mencetaknya selalu pada kesalahan standar saat pekerjaan baru
dibuat), gunakan opsi "-j" untuk membuat ulang pekerjaan.

Contoh:

./panalysis.PLS -n 'edit.seqret'
sequence_direct_data=@/home/testdata/my.seq

Ini mencetak:

JOB ID: edit.seqret/bb494b:ef55e47c99:-8000

Panggilan berikutnya (meminta untuk menjalankan pekerjaan, menunggu penyelesaiannya dan menunjukkan status pekerjaan)
dapat:

./panalysis.PLS -n 'edit.seqret'
-j edit.seqret/bb494b:ef55e47c99:-800
-w -s

Dan lagi nanti permintaan lain dapat meminta hasil:

./panalysis.PLS -n 'edit.seqret'
-j edit.seqret/bb494b:ef55e47c99:-800
-r

Berikut adalah daftar semua opsi pekerjaan (kecuali untuk hasil, ada di bagian berikutnya):

Eksekusi dan pemutusan pekerjaan
Ada opsi yang sama "-x" dan "-w" untuk menjalankan pekerjaan dan untuk menjalankannya dan
menunggu penyelesaiannya, seperti yang dijelaskan di atas. Tapi sekarang, opsinya bertindak
pekerjaan yang diberikan oleh opsi "-j", sekarang mereka tidak menggunakan data input apa pun dari perintah-
baris (data input harus digunakan saat pekerjaan dibuat).

Selain itu, ada opsi "-k" untuk mematikan pekerjaan yang sedang berjalan.

Karakteristik pekerjaan
Pilihan lain menceritakan tentang status pekerjaan ("-s", tentang waktu pelaksanaan pekerjaan ("-t" dan
"-T", dan tentang kejadian terakhir yang tersedia apa yang terjadi dengan pekerjaan ("-e"). Perhatikan bahwa
pemberitahuan acara belum sepenuhnya diterapkan, jadi opsi ini akan berubah di
masa depan untuk mencerminkan lebih banyak kemampuan pemberitahuan.

Hasil
Tentu saja, alat analisis yang paling penting adalah hasilnya. Hasilnya adalah
diberi nama (dengan cara yang sama seperti data input) dan mereka dapat diambil sekaligus menggunakan
opsi "-r" (sehingga Anda tidak perlu mengetahui nama mereka sebenarnya), atau dengan menentukan (semua atau
beberapa) nama hasil menggunakan opsi "-R".

Jika hasilnya tidak ada (baik belum, atau namanya salah) nilai undef adalah
dikembalikan (tidak ada pesan kesalahan yang dihasilkan).

Beberapa hasil lebih baik disimpan langsung ke dalam file daripada ditampilkan di terminal
jendela (ini berlaku untuk biner hasil, sebagian besar berisi gambar). "panalisis.PLS"
membantu menangani hasil biner dengan menyimpannya secara otomatis ke file lokal (sebenarnya itu
adalah modul "Bio::Tools::Run::Analysis" dan submodulnya yang membantu dengan biner
data).

Jadi mengapa tidak menggunakan pengalihan shell tradisional ke file? Ada dua alasan.
Pertama, sebuah pekerjaan dapat menghasilkan lebih dari satu hasil, sehingga mereka akan dicampur bersama. Tetapi
terutama, karena setiap hasil dapat terdiri dari beberapa bagian yang jumlahnya tidak diketahui
muka dan yang tidak dapat dicampur menjadi satu dalam satu file. Sekali lagi, ini tipikal untuk
data biner mengembalikan gambar - sebuah permintaan dapat menghasilkan banyak gambar.

Opsi "-r" mengambil semua hasil yang tersedia dan memperlakukannya seperti yang dijelaskan oleh '?'
format di bawah ini.

Opsi "-R" memiliki daftar nama hasil yang dipisahkan koma, masing-masing nama dapat berupa
baik nama sederhana (seperti yang ditentukan oleh "spesifikasi hasil" yang dapat diperoleh menggunakan "-o"
atau opsi "-O"), atau konstruksi nama/format yang dipisahkan tanda sama dengan yang menyarankan apa yang harus dilakukan
dengan hasilnya. Kemungkinannya adalah:

nama-hasil
Ini mencetak hasil yang diberikan pada output standar.

nama-hasil=namafile
Ini menyimpan hasil yang diberikan ke dalam file yang diberikan.

nama-hasil=@
Ini menyimpan hasil yang diberikan ke dalam file yang namanya secara otomatis ditemukan, dan itu
menjamin bahwa nama yang sama tidak akan digunakan pada pemanggilan berikutnya.

hasil=nama=@templat
Ini menyimpan hasil yang diberikan ke dalam file yang namanya diberikan oleh "templat". NS
template dapat berisi beberapa string yang diganti sebelum digunakan sebagai
nama file:

Setiap '*'
Akan diganti dengan nomor unik

$ANALYSIS atau ${ANALYSIS}
Akan diganti dengan nama analisis saat ini

$RESULT atau ${RESULT}
Akan diganti dengan nama hasil saat ini

Bagaimana cara mengetahui apa yang harus dilakukan dengan hasil? Setiap nama hasil

Selain itu, template dapat diberikan sebagai variabel lingkungan
"RESULT_FILENAME_TEMPLATE". Variabel tersebut digunakan untuk hasil apa pun yang memiliki formatnya
sederhana "?" atau karakter "@".

nama-hasil=?
Ini pertama memutuskan apakah hasil yang diberikan adalah biner atau tidak. Kemudian, hasil binernya
disimpan ke file lokal yang namanya secara otomatis ditemukan, hasil lainnya
dikirim ke output standar.

nama-hasil=?templat
Sama seperti di atas tetapi nama file untuk file biner disimpulkan dari yang diberikan
template (menggunakan aturan yang sama seperti yang dijelaskan di atas).

contoh:

-r
-R laporan
-R laporan, outseq
-R Grafik_dalam_PNG=@
-R Grafik_in_PNG=@$ANALISIS-*-$HASIL

Perhatikan bahwa pemformatan hasil akan diperkaya di masa mendatang dengan menggunakan tipe data yang ada
parser di bioperl.

KOMENTAR

Mailing daftar
Umpan balik pengguna merupakan bagian integral dari evolusi modul ini dan modul Bioperl lainnya. Mengirim
komentar dan saran Anda sebaiknya ke milis Bioperl. Partisipasi Anda
sangat dihargai.

[email dilindungi] - Diskusi Umum
http://bioperl.org/wiki/Mailing_lists - Tentang milis

Pelaporan Bug
Laporkan bug ke sistem pelacakan bug Bioperl untuk membantu kami melacak bug dan mereka
resolusi. Laporan bug dapat dikirimkan melalui web:

http://redmine.open-bio.org/projects/bioperl/

Gunakan bp_panalysis.plp online menggunakan layanan onworks.net