Wymagania

Program dostępny jest w wersjach przeznaczonych dla systemów operacyjnych Windows, Linux i MacOS X.

Niezależnie od systemu operacyjnego do działania programu konieczna jest obecność na komputerze maszyny wirtualnej Javy (JRE - Java Runtime Engine) w wersji 1.7.

O tym, czy JRE w odpowiedniej wersji jest obecny w systemie można przekonać się wpisując z linii komend polecenie:

java -version

Jeżeli JRE jest zainstalowany, to efektem polecenia powinien być komunikat podobny do widocznego na poniższym obrazku.

Prawidłowy efekt działania polecenie java -version

W przypadku braku JRE w odpowiedniej wersji konieczne jest jego ściągnięcie i instalacja. Najnowsze wersje JRE dla systemów Windows i Linux dostępne są na stronie firmy Oracle. W popularnych dystrybucjach systemu Linux (np. Ubuntu, OpenSUSE) domyślnie instalowana jest rozwijana na zasadach open-source maszyna wirtualna IcedTea z klasami OpenJDK. Zestaw ten jest odpowiednikiem JRE firmy Oracle i MScan powinien również z nim działać, ale nie jest pod tym kątem sprawdzany.



Instalacja

Instalacja w systemach Windows i Linux polega na rozpakowaniu zawartości archiwum z programem (odpowiednio MScan.zip lub MScan.tgz) do dowolnego katalogu.

W przypadku systemu MacOS X należy zamontować obraz dysku MScan.dmg i przegrać jego zawartość do dowolnego katalogu.



Uruchomienie

Pod systemami Windows i Linux program może być uruchomiony za pomocą dwukrotnego kliknięcia na ikony skryptów startowych (odpowiednio MScan.bat lub MScan.sh). Możliwe jest również uruchomienie skryptów z poziomu linii komend.

W systemie MacOS X program uruchamia się przez dwukrotne kliknięcie na ikonę MScan.app.



Konfiguracja


Plik konfiguracyjny

Domyślnie MScan podczas startu odczytuje plik konfiguracyjny MScan.cfg znajdujący się w katalogu z programem. Zachowanie to może zostać zmienione przez edycję skryptów startowych (Mscan.bat lub Mscan.sh, w zależności od systemu operacyjneg). Nazwa i położenie pliku konfiguracyjnego przekazywana jest do programu a pomocą opcji -c.

Plik MScan.cfg jest plikiem tekstowym i możliwa jest jego edycja w dowolnym edytorze, aczkolwiek zwykle nie ma takiej potrzeby, jako że większość opcji dostępnych jest z poziomu interfejsu graficznego programu za pośrednictwem okna dialogowego Configuration z menu File.

Plik konfiguracyjny zawiera następujące pola (linie zaczynające się od znaku "#" są traktowane jako komentarze):



Definiowanie własnych modyfikacji

Wewnątrz programu zdefiniowane są następujące modyfikacje:

Dodatkowe modyfikacje mogą być zdefiniowane w pliku tekstowym o nazwie podanej w polu MODFILE pliku konfiguracyjnego (domyślną nazwą jest ModTable.txt). Plik z modyfikacjami wczytywany jest podczas uruchamiania programu oraz przy ponowynym odczycie konfiguracji. Przykładowy plik z modyfikacjami jest dostępny tutaj oraz w archiwum z programem.

Dla modyfikacji określanych przez Mascota jako variable modifications format jest następujący:

NAZWA AMINOKWASY SEKWENCJA(lub MASA) 1

Pole SEKWENCJA skład chemiczny samej modyfikacji (np. hpo3 dla PHOSPHO (ST), dostępne pierwiastki to: h, c, n, o, p, s) i pozwala na zdefiniowanie jedynie modyfikacji addytywnych. Definicja za pomocą masy polega na podaniu masy samej modyfikacji (np. 79.96633 dla PHOSPHO (ST)) i pozwala uzyskać modyfikacje subtraktywne, ale za to uniemożliwia właściwe wyznaczenie obiedni izotopowej.

Dla fixed modifications format jest następujący:

NAZWA AMINOKWAS SEKWENCJA 0

Pole SEKWENCJA oznacza skład chemiczny zmodyfikowanej reszty aminokwasowej (np. c5h8n2o2s dla CARBAMIDOMETHYL (C)).

Dla obydwu rodzajów modyfikacji pola muszą być rozdzielone zanakami tabulacji (spacja nie wystarczy). Linie zaczynające się od znaku "#" traktowane są jako komentarze.




Import sekwencji białek

Po wybraniu opcji Import → Import protein sequences z menu File pojawia się okno dialogowe pozwalające na wybór, czy import będzie się odbywał z sieci czy też z pliku FASTA (lista Source) oraz sposobu w jaki identyfikowane będą zaimportowane sekwencje (lista Database - domyślnie jej stan jest taki sam jak w aktywnym eksprymencie i nie powino się go zmieniać, chyba że odpowiednich zmian dokona się również we właściwościach eksperymentu).

Import z sieci jest możliwy tylko w wypadku gdy otwarty jest eksperyment, w którym Mascot wykorzystywał bazy danych NCBI, SwissProt lub SGD. Importowane są zaznaczone na liście białka, lub wszystkie występujące w eksperymencie w wypadku braku zaznaczenia. Sekwencje zapamiętywane są w lokalnej bazie danych. Wybór pozycji na liście "After download" określa czy zostaną również zapisanie w pliku zaraz po zakończeniu ściągania (Do nothing - brak zapisu, Save raw FASTA - zapisanie sekwencji w oryginalnej postaci, Save FASTA - zapisanie w nieco zmienionej postaci).

Import z pliku działa podobnie jak w poprzednich wersjach programu, z wyjątkiem tego, że poprawiona jest obsługa sekwencji pochodzących z innych baz danych (czyli przy liście Database ustawionej na Other). Prawidłowe wczytanie takich sekwencji wymaga zachowania odpowiedniego formatu lini deskryptora FASTA:

Poniżej przykład zamiany formatu FASTA bazy IPI (górny) na zjadliwy dla programu (dolny):

>IPI:IPI00000005.1|SWISS-PROT:P01111|TREMBL:Q5U091|REFSEQ:NP_002515 Tax_Id=9606 Gene_Symbol=NRAS GTPase

>IPI|IPI00000005.1|sp|P01111|TREMBL|Q5U091|REFSEQ|NP_002515|Tax_Id=9606 Gene_Symbol=NRAS GTPase



Identyfikatory baz danych

Do prawidłowego działania konwersji pomiędzy numerami GI z bazy NCBI a identyfikatorami z baz SwissProt i SGD potrzebne są pliki gi2sp i gi2sgd, które po rozpakowaniu należy umieścić w katolgu zdefiniowanym w pliku konfiguracyjnym.

Aktulaną wersją pliku gi2sp można również utworzyć za pomocą programu UpdateGI2SP.



Programy pomocnicze



MPercolator

Mpercolator jest zmodyfikowaną wersją programu MascotPercolator, który służy do liczenia scorów Percolatora dla plików DAT pochodzących z przeszukań Mascota z zaznaczoną opcją decoy. Efektem działania programu są pliki o rozszerzeniu DATP, w których score Mascota zastępowane są wyliczonymi przez Percolatora wartościami PEP, czyli prawdopodobieństwami błędnej identyfikacji peptydów.

Wymagania i instalacja

Instalacja programu polega na rozpakowaniu zawartości archiwum do wybranego katalogu. Do prawidłowego działania wymagana jest obecność na komputerze maszyny wirtualnej Javy (JRE - Java Runtime Engine) w wersji 1.6 lub wyższej (musi to być wersja oryginalna firmy Oracle, program nie będzie dziać na maszynie wirtualna IcedTea z klasami OpenJDK).

W przypadku systemu GNU/Linux wymagane jest również zainstalowanie bibliotek xercxes-c i boost. Działanie binarnej wersji programu Percolator znajdującej się w archiwum było weryfikowane pod Debianem Wheezy i Ubuntu 12.04 - w przypadku innych dystrybucji konieczna może być ponowna kompilacja.

Pod systemem Windows wymagane jest zainstalowanie bibliotek Microsoft Visual C++ 2005 Service Pack 1 Redistributable Package MFC Security Update w wersji zgodnej z używaną maszyną wirtualną Javy: x64 dla 64-bitowego JRE lub x86 dla 32-bitowego JRE.

Niezależnie od systemu operacyjnego należy pamiętać o zmianie ustawień regionalnych na normalne, czyli w żadnym wypadku nie polskie. Znaczenie mają znaki separatora dziesiętnego i separatora listy, które powinny być ustawione na, odpowiednio: kropkę i przecinek. Jeżeli zostawi się przecinek jako separator dziesiętny program albo się nie uruchomi (dając komunikat, że nie może znaleźć definicji modyfikacji potranslacyjnych), albo - co gorsza - uruchomi się, ale będzie źle liczył. Pod systemem Windows zmiana ustawień regionalnych jest możliwa za pośrednictwem panelu kontrolnego "Opcje regionalne i językowe" ("Regional and language options" w wersji anglojęzycznej Windows), natomiast pod GNU/Linux można to zrobić za pomocą zmiennych powłoki LC_NUMERIC i LANG (znaczenie mają locale w konsoli tekstowej a nie te stosowane dla środowiska graficznego).

Uwaga dodatkowa dotycząca systemu Windows: program nie powinien być umieszczany w katalogu o zbyt długiej nazwie, bo wtedy niemożliwe okazuje się prawidłowe wywołanie programu Percolator.

Sposób wywołania

Program wywoływany jest z linii komend za pośrednictwem skryptu mpercolator.bat (system Windows) lub mpercolator.sh (dla systemu GNU/Linux). Argumentem skryptu są nazwy wejściowych plików DAT (można stosować znaki uogólniające), które powinny znajdować się w tym samym katalogu co program. Program obsługuje jedynie pliki dla plików DAT pochodzące z przeszukań Mascota z zaznaczoną opcją decoy. Ponadto pliki wejściowe nie powinny zawierać w nazwie litery "F" (wbrew pozorom to nie jest żart).

Poniżej zamieszczony został obrazek z przykładowego wywołania programu...

Przykład wywołania programu MPercolator

... oraz prawidłowego zakończenia jego działania.

Przykład dzialania programu MPercolator

Efektem działania programu jest wygenerowanie plików o nazwach takich samych jak pliki wejściowe i rozszerzeniach DATP, które mogą zostać następnie wczytane do MScana.



gi2sp

Do archiwum z programem MScan dołączny jest program UpdateGI2SP umożliwiający automatyczną aktualizacje pliku gi2sp służacego do konwersji pomiędzy identyfikatorami bazy SwissProt a numerami GI bazy NCBI

Program wywoływany jest z linii komend za pomocą poleceń:

UpdateGI2SP.bat [nazwa_piku_wejściowego] (system Windows)

lub

UpdateGI2SP.sh [nazwa_piku_wejściowego] (systemy Linux i MacOS X)

Podczas działania program wykonuje następujące czynności: ściąga plik swissprog.gz z serwera NCBI i po rozpakowaniu dokonuje jego konwersji do postaci wymaganej przez MScan. W wypadku podania nazwy pliku wejściowego z linii komend nie jest on ściągany ani ropakowywany. Plik wynikowy o nazwie gi2sp.new należy przegrać do katalogu zdefiniowanego w polu GI2SP pliku konfiguracyjnego MScan.cfg i zmienić jego nazwę na tak aby była zgodna z zawartością tego pola (domyślnie gi2sp).



Opis programu


Autor


Tymon Rubel

Instytut Radioelektroniki
Politechnika Warszawska