annotate README.md @ 5:8190f6083c0d draft

"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 24561502a9bed97f351af6a0438aa82414a351ab"
author galaxyp
date Sat, 30 Oct 2021 13:06:22 +0000
parents f5c632894818
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
1 # MzToSQLite
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
2
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
3 ## Description
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
4
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
5 Parses MzIdentML, FASTA and MGF scan files into a SQLite3 database. The schema is used by MVPApplication in visualizing the parsed data.
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
6
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
7 ## General Requirements
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
8
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
9 MzToSQLite is threaded during the read stages of processing. It is single threaded during SQL writes. It will perform best when given one core per MGF file. But it runs well with between two and four cores.
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
10
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
11 Reading the MGF files is memory intensive, set the _JAVA_OPTIONS to the minimum recommended below.
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
12
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
13 **Example Recommended Settings**
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
14
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
15 One core, minimum memory:
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
16 _JAVA_OPTIONS: -Xms20G -Xmx20G
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
17
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
18 Four core, slightly faster performance (performance determined by size of each MGF file):
f5c632894818 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/mz_to_sqlite commit 75b9f57bf0b41b2a0b1e1c9f73447a1125fc245e"
galaxyp
parents:
diff changeset
19 _JAVA_OPTIONS: -Xms40G -Xmx40G