Wymagania
Program dostępny jest w wersjach przeznaczonych dla systemów operacyjnych Windows i Linux (64-bit).
Instalacja
Instalacja w systemach Windows i Linux polega na rozpakowaniu zawartości archiwum z programem (odpowiednio MSparky.zip lub MSparky.tgz) 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 msparky\bin\msparky.bat lub msparky/bin/msparky). Możliwe jest również uruchomienie skryptów z poziomu linii komend.
Konfiguracja
Pliki konfiguracyjne
Ustawienia domyślne wybranych okien dialogowych programu MSparky mogą być zmieniane za pomocą odpowiadających im plików konfiguracyjnych, znajdujących się w katalogu msparky\config. Zawartość plików konfiguracyjnych może zostać zmieniona za pomocą dowolnego edytora tekstu. Linie zaczynające się od znaku "#" są traktowane jako komentarze.
Plik konfiguracyjny funkcji szukania peptydów (okno dialogowe Find peptides, plik findpeptides.cfg) zawiera następujące pola:
FP_CH_PEAKS_COUNT- liczba pików obwiedni izotopowej uwzględnianych podczas wyznaczania chromatogramuFP_CH_MZ_RANGE- szerokość chromatogramu w jednostkach ppmFP_CH_REQUIRE_MAX- włączenie/wyłączenie sprawdzania obecności maksimum piku w zakresie m/z, w którym tworzony jest chromatogramFP_CH_THRESHOLD- minimalna liczba zliczeń brana pod uwagę podczas liczenia chromatogramuFP_CH_FILTERING- włączenie/wyłączenie filtracji dolnoprzepustowej chromatogramuFP_CH_FILTER_TYPE- rodzaj filtru (uśrednianie w oknie, filtr Savitzky'ego-Golaya, filtr Gaussowski)FP_CH_FILTER_SPAN- szerokość filtruFP_CH_FILTER_ORDER- rząd filtruFP_CH_RT_PENALITY- włączenie/wyłączenie kary za odstępstwo od teoretycznego czasu retencjiFP_CH_RT_PENALITY_S- szerokość funkcji kary za odstępstwo od teoretycznego czasu retencjiFP_CH_MAX_ELIMINATION- włączenie/wyłącznie eliminacji maximów lokalnych chromatogramu o wysokości mniejszej od progu zdefiniowanego przez poleFP_CH_MAX_THRESHOLDFP_CH_SORT_PEAKS- sposób sortowania pików chromatogramu (brak, wysokość lub zgodność z teoretycznym czasem retencji)FP_FIT_PEAKS_COUNT- liczba pików uwzględnianych podczas liczenie dopasowania teoretyczego modelu widma mas peptydu do danych pomiarowychFP_SPECTRUM_RT_CORRECTION- uwzględnianie funkcji kalibracji osi m/zFP_SPECTRUM_RT_FWMH- wwzględnianie estymowanej precyzji pomiaru wzdłuż osi m/zFP_SPECTRUM_MZ_CORRECTION- uwzględnianie funkcji kalibracji osi RTFP_SPECTRUM_MZ_RANGE- Uwzględnianie estymowanej precyzji pomiaru wzdłuż osi RTFP_SPECTRUM_RP_CORRECTION- uwzględnianie funkcji korekcji rozdzielczości spektrometru wzdłuż osi RT
Plik konfiguracyjny listy peptydów (okno dialogowe Peptides list, plik peptideslist2.cfg) zawiera następujące pola:
PL2_DELTA_MZ- zaznaczanie flagą przekroczenia progu różnicy pomiędzy teoretyczną wartością m/z a znalezionym położeniem piku monoizotopowego wzdłuż osi m/z. Wartość progu w jednostkach ppm definiowana jest przez polePL2_DELTA_MZ_THPL2_MZ_FLAG- zaznaczanie flagą błędów podczas wyznaczania dopasowania obwiedni izotopowej peptyduPL2_MZ_RMS- zaznaczanie flagą przekroczenia progu błędu średniokwadratowego dopasowania obwiedni izotopowej. Wartość progu definiowana jest przez polePL2_MZ_RMS_THPL2_MZ_RSQUARE- zaznaczanie flagą nie przekroczenia progu współczynnika determinacji podczas liczenia dopasowania obwiedni izotopowej. Wartość progu (od 0 do 1) definiowana jest przez polePL2_MZ_RSQUARE_THPL2_DELTA_MRT- zaznaczanie flagą przekroczenia progu różnicy pomiędzy teoretyczną wartością RT a znalezionym położeniem piku monoizotopowego wzdłuż osi RT . Wartość progu w minutach definiowana jest przez polePL2_DELTA_MRT_THPL2_RT_FLAG- zaznaczanie flagą błędów podczas wyznaczania dopasowania profilu elucji peptyduPL2_RT_RMS- zaznaczanie flagą przekroczenia progu błędu średniokwadratowego dopasowania profilu elucji. Wartość progu definiowana jest przez polePL2_RT_RMS_THPL2_RT_RSQUARE- zaznaczanie flagą nie przekroczenia progu współczynnika determinacji podczas liczenia dopasowania profilu elucji. Wartość progu (od 0 do 1) definiowana jest przez polePL2_RT_RSQUARE_THPL2_ENV_RMS- zaznaczanie flagą przekroczenia progu błędu średniokwadratowego pomiędzy teoretyczną i pomiarową obwiednią izotopową. Wartość progu definiowana jest przez polePL2_ENV_RMS_THPL2_ENV_RSQUARE- zaznaczanie flagą nie przekroczenia progu współczynnika determinacji pomiędzy teoretyczną i pomiarową obwiednią izotopową. Wartość progu (od 0 do 1) definiowana jest przez polePL2_ENV_RSQUARE_THPL2_PEAKS- zaznaczanie flagą peptydów o liczbie pików obwiedni mniejszej od zdefiniowanej w poluPL2_PEAKS_THPL2_DATA_HEIGHT- sposób wyzanczania wartości ilościowych peptydów (wysokość pików odczytana z danych, wysokość pików wyznaczona z dopasowanego modelu, objętość pików wyznaczona z modelu)PL2_ONLY_MONOISOTOPIC- wyznaczonych wartości ilościowych peptydów na podstawie piku monizotopowegoPL2_LOG_SCALE- podawanie wartości ilościowych peptydów w skali logarytmicznej
Plik konfiguracyjny funkcji rysowania chromatogramu (okno dialogowe Chromatogram, plik chromatogram.cfg) zawiera następujące pola:
CH_PEAKS_COUNT- liczba pików obwiedni izotopowej uwzględnianych podczas wyznaczania chromatogramuCH_MZ_RANGE- szerokość chromatogramu w jednostkach ppmCH_REQUIRE_MAX- włączenie/wyłączenie sprawdzania obecności maksimum piku w zakresie m/z, w którym tworzony jest chromatogramCH_THRESHOLD- minimalna liczba zliczeń brana pod uwagę podczas liczenia chromatogramuCH_FILTERING- włączenie/wyłączenie filtracji dolnoprzepustowej chromatogramuCH_FILTER_TYPE- rodzaj filtru (uśrednianie w oknie, filtr Savitzky'ego-Golaya, filtr Gaussowski)CH_FILTER_SPAN- szerokość filtruCH_FILTER_ORDER- rząd filtruCH_RT_PENALITY- włączenie/wyłączenie kary za odstępstwo od teoretycznego czasu retencjiCH_RT_PENALITY_S- szerokość funkcji kary za odstępstwo od teoretycznego czasu retencjiCH_MAX_ELIMINATION- włączenie/wyłącznie eliminacji maximów lokalnych chromatogramu o wysokości mniejszej od progu zdefiniowanego przez poleCH_MAX_THRESHOLDSPECTRUM_RT_CORRECTION- uwzględnianie funkcji kalibracji osi m/zSPECTRUM_RT_FWMH- wwzględnianie estymowanej precyzji pomiaru wzdłuż osi m/zSPECTRUM_MZ_CORRECTION- uwzględnianie funkcji kalibracji osi RTSPECTRUM_MZ_RANGE- Uwzględnianie estymowanej precyzji pomiaru wzdłuż osi RTSPECTRUM_RP_CORRECTION- uwzględnianie funkcji korekcji rozdzielczości spektrometru wzdłuż osi RT
Domyślny katalog z danymi
Domyślny katalog z danymi określany jest przez wartość zmiennej powłoki SPARKYHOME, zdefiniowanej w skryptach startowych msparky\bin\msparky.bat (system Windows) lub msparky/bin/msparky (system Linux). Katalog wskazywany przez tą zmienną powinien zawierać trzy podkatalogi o nazwach: Save, Projects i Lists.
Programy pomocnicze
Program Mergelists służy do łączenia list peptydów będących wynikiem przeszukiwania widm przez program MSparky (pliki SAVE lub LIST) w pojedynczy zbiór danych w formacie wymaganym przez program MStat.
Program wywoływany jest dwukrotne kliknięcie na ikonę skryptu startowego (Mergelist.bat dla systemu Winsows lub DatViewer.sh dla systemów Linux i MacOS X). Możliwe jest również uruchomienie skryptów z poziomu linii komend.

Program odczytuje wszystkie pliki o rozszerzeniu zdefiniowanym w polu Input files ext. znajdujące się w katalogu Input directory i po połączeniu zapisuje w pliku o nazwie wybranej w polu Output file