Package eu.isas.peptideshaker.cmd
Class CLIExportMethods
java.lang.Object
eu.isas.peptideshaker.cmd.CLIExportMethods
This class groups standard methods used by the different command line
interfaces.
- Author:
- Marc Vaudel, Harald Barsnes
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic FileexportAccessions(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.waiting.WaitingHandler waitingHandler, com.compomics.util.gui.filtering.FilterParameters filteringPreferences) Exports the accessions as specified in the follow-up input bean.exportDeepLC(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.ModificationParameters modificationParameters, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports files needed by DeepLC.static voidexportDocumentation(ReportCLIInputBean reportCLIInputBean, String reportType, com.compomics.util.waiting.WaitingHandler waitingHandler) Writes the documentation corresponding to an export given the command line arguments.static FileexportInclusionList(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.identification.features.IdentificationFeaturesGenerator identificationFeaturesGenerator, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.parameters.identification.search.SearchParameters searchParameters, com.compomics.util.waiting.WaitingHandler waitingHandler, com.compomics.util.gui.filtering.FilterParameters filterPreferences) Exports an inclusion list of the validated hits.exportMs2pip(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.SearchParameters searchParameters, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports the files needed by ms2pip.static voidexportMzId(MzidCLIInputBean mzidCLIInputBean, PsdbParent psbdParent, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports the project in the mzIdentML format.static voidexportPeaksIntensities(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.SearchParameters searchParameters, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.identification.spectrum_annotation.AnnotationParameters annotationParameters, com.compomics.util.parameters.identification.advanced.ModificationLocalizationParameters modificationLocalizationParameters, com.compomics.util.parameters.identification.search.ModificationParameters modificationParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports the peaks intensities (observed).static voidexportPercolator(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.SearchParameters searchParameters, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.identification.spectrum_annotation.AnnotationParameters annotationParameters, com.compomics.util.parameters.identification.advanced.ModificationLocalizationParameters modificationLocalizationParameters, com.compomics.util.parameters.identification.search.ModificationParameters modificationParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports the files needed by Percolator.static FileexportProgenesis(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.waiting.WaitingHandler waitingHandler, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.io.biology.protein.ProteinDetailsProvider proteinDetailsProvider, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingPreferences) Exports the identification in a Progenesis compatible format.static FileexportProteinSequences(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.waiting.WaitingHandler waitingHandler, com.compomics.util.gui.filtering.FilterParameters filteringPreferences) Exports the protein details in FASTA format as specified in the follow-up input bean.static FileexportProteoforms(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports proteoforms.static voidexportPSMIdentifiers(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.ModificationParameters modificationParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) static FileexportReport(ReportCLIInputBean reportCLIInputBean, String reportType, String experiment, ProjectDetails projectDetails, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.biology.genes.GeneMaps geneMaps, com.compomics.util.experiment.identification.features.IdentificationFeaturesGenerator identificationFeaturesGenerator, com.compomics.util.parameters.identification.IdentificationParameters identificationParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.io.biology.protein.ProteinDetailsProvider proteinDetailsProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, int nSurroundingAA, com.compomics.util.parameters.quantification.spectrum_counting.SpectrumCountingParameters spectrumCountingPreferences, com.compomics.util.waiting.WaitingHandler waitingHandler) Writes an export according to the command line settings contained in the reportCLIInputBean.static voidexportRTValues(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.SearchParameters searchParameters, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.identification.spectrum_annotation.AnnotationParameters annotationParameters, com.compomics.util.parameters.identification.advanced.ModificationLocalizationParameters modificationLocalizationParameters, com.compomics.util.parameters.identification.search.ModificationParameters modificationParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports the RT values (observed,predicted).exportSpectra(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingPreferences) Exports the spectra as specified in the follow-up input bean.recalibrateSpectra(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.parameters.identification.IdentificationParameters identificationParameters, com.compomics.util.waiting.WaitingHandler waitingHandler) Recalibrates spectra as specified in the follow-up input bean.
-
Constructor Details
-
CLIExportMethods
public CLIExportMethods()
-
-
Method Details
-
recalibrateSpectra
public static ArrayList<File> recalibrateSpectra(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.parameters.identification.IdentificationParameters identificationParameters, com.compomics.util.waiting.WaitingHandler waitingHandler) throws IOException Recalibrates spectra as specified in the follow-up input bean.- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationsequenceProvider- the sequence providerspectrumProvider- The spectrum provider.identificationParameters- the identification parameterswaitingHandler- a waiting handler to display progress- Returns:
- ArrayList files containing the recalibrated spectra
- Throws:
IOException- exception thrown whenever an IO exception occurred while reading or writing to a file
-
exportSpectra
public static ArrayList<File> exportSpectra(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingPreferences) throws IOException, SQLException, ClassNotFoundException, InterruptedException Exports the spectra as specified in the follow-up input bean.- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationspectrumProvider- The spectrum provider.waitingHandler- a waiting handler to display progresssequenceMatchingPreferences- the sequence matching preferences- Returns:
- ArrayList files containing the spectra
- Throws:
IOException- exception thrown whenever an IO exception occurred while reading or writing to a fileInterruptedException- exception thrown whenever a threading issue occurred while interacting with the databaseSQLException- exception thrown whenever an SQL exception occurred while interacting with the databaseClassNotFoundException- exception thrown whenever an exception occurred while deserializing an object
-
exportAccessions
public static File exportAccessions(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.waiting.WaitingHandler waitingHandler, com.compomics.util.gui.filtering.FilterParameters filteringPreferences) throws IOException Exports the accessions as specified in the follow-up input bean.- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationsequenceProvider- the FASTA sequence providerwaitingHandler- a waiting handler to display progressfilteringPreferences- the filtering preferences- Returns:
- File file containing accessions
- Throws:
IOException- exception thrown whenever an IO exception occurred while reading or writing to a file
-
exportProteinSequences
public static File exportProteinSequences(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.waiting.WaitingHandler waitingHandler, com.compomics.util.gui.filtering.FilterParameters filteringPreferences) throws IOException Exports the protein details in FASTA format as specified in the follow-up input bean.- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationsequenceProvider- the FASTA sequence providerwaitingHandler- a waiting handler to display progressfilteringPreferences- the filtering preferences- Returns:
- File file containing the protein details in FASTA format
- Throws:
IOException- exception thrown whenever an IO exception occurred while reading or writing to a file
-
exportProgenesis
public static File exportProgenesis(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.waiting.WaitingHandler waitingHandler, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.io.biology.protein.ProteinDetailsProvider proteinDetailsProvider, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingPreferences) throws IOException Exports the identification in a Progenesis compatible format.- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationwaitingHandler- a waiting handler to display progresssequenceProvider- the sequence providerproteinDetailsProvider- the protein details providersequenceMatchingPreferences- the sequence matching preferences- Returns:
- File file containing the identification data in a Progenesis compatible format
- Throws:
IOException- exception thrown whenever an IO exception occurred while reading or writing to a file
-
exportProteoforms
public static File exportProteoforms(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports proteoforms.- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationwaitingHandler- a waiting handler to display progress- Returns:
- File file containing the proteoforms data
-
exportDeepLC
public static ArrayList<File> exportDeepLC(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.ModificationParameters modificationParameters, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports files needed by DeepLC.- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationmodificationParameters- The modification parameters.sequenceMatchingParameters- The sequence matching parameters.sequenceProvider- The sequence provider.spectrumProvider- The spectrum provider.waitingHandler- The waiting handler.- Returns:
- The files created by the export.
-
exportMs2pip
public static ArrayList<File> exportMs2pip(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.SearchParameters searchParameters, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports the files needed by ms2pip.- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationsearchParameters- The search parameters.sequenceMatchingParameters- The sequence matching parameters.sequenceProvider- The sequence provider.spectrumProvider- The spectrum provider.waitingHandler- The waiting handler.- Returns:
- The files created by the export.
-
exportPercolator
public static void exportPercolator(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.SearchParameters searchParameters, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.identification.spectrum_annotation.AnnotationParameters annotationParameters, com.compomics.util.parameters.identification.advanced.ModificationLocalizationParameters modificationLocalizationParameters, com.compomics.util.parameters.identification.search.ModificationParameters modificationParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports the files needed by Percolator.- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationsearchParameters- The search parameters.sequenceMatchingParameters- The sequence matching parameters.annotationParameters- The annotation parameters.modificationLocalizationParameters- The modification localization parameters.modificationParameters- The modification parameters.sequenceProvider- The sequence provider.spectrumProvider- The spectrum provider.waitingHandler- The waiting handler.
-
exportPeaksIntensities
public static void exportPeaksIntensities(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.SearchParameters searchParameters, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.identification.spectrum_annotation.AnnotationParameters annotationParameters, com.compomics.util.parameters.identification.advanced.ModificationLocalizationParameters modificationLocalizationParameters, com.compomics.util.parameters.identification.search.ModificationParameters modificationParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports the peaks intensities (observed).- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationsearchParameters- the search parameterssequenceMatchingParameters- the sequence matching parametersannotationParameters- the annotation parametersmodificationLocalizationParameters- the modification localization parametersmodificationParameters- the modification parameterssequenceProvider- the sequence providerspectrumProvider- the spectrum providerwaitingHandler- the waiting handler
-
exportRTValues
public static void exportRTValues(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.SearchParameters searchParameters, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.identification.spectrum_annotation.AnnotationParameters annotationParameters, com.compomics.util.parameters.identification.advanced.ModificationLocalizationParameters modificationLocalizationParameters, com.compomics.util.parameters.identification.search.ModificationParameters modificationParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) Exports the RT values (observed,predicted).- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationsearchParameters- The search parameters.sequenceMatchingParameters- The sequence matching parameters.annotationParameters- The annotation parameters.modificationLocalizationParameters- The modification localization parameters.modificationParameters- The modification parameters.sequenceProvider- The sequence provider.spectrumProvider- The spectrum provider.waitingHandler- The waiting handler.
-
exportPSMIdentifiers
public static void exportPSMIdentifiers(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.parameters.identification.search.ModificationParameters modificationParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters sequenceMatchingParameters, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.waiting.WaitingHandler waitingHandler) -
exportInclusionList
public static File exportInclusionList(FollowUpCLIInputBean followUpCLIInputBean, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.identification.features.IdentificationFeaturesGenerator identificationFeaturesGenerator, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, com.compomics.util.parameters.identification.search.SearchParameters searchParameters, com.compomics.util.waiting.WaitingHandler waitingHandler, com.compomics.util.gui.filtering.FilterParameters filterPreferences) throws IOException Exports an inclusion list of the validated hits.- Parameters:
followUpCLIInputBean- the follow up input beanidentification- the identificationidentificationFeaturesGenerator- the identification features generatorspectrumProvider- The spectrum provider.searchParameters- the search parameterswaitingHandler- a waiting handler to display progressfilterPreferences- the filter preferences- Returns:
- File file containing the inclusion list
- Throws:
IOException- exception thrown whenever an IO exception occurred while reading or writing to a file
-
exportReport
public static File exportReport(ReportCLIInputBean reportCLIInputBean, String reportType, String experiment, ProjectDetails projectDetails, com.compomics.util.experiment.identification.Identification identification, com.compomics.util.experiment.biology.genes.GeneMaps geneMaps, com.compomics.util.experiment.identification.features.IdentificationFeaturesGenerator identificationFeaturesGenerator, com.compomics.util.parameters.identification.IdentificationParameters identificationParameters, com.compomics.util.experiment.io.biology.protein.SequenceProvider sequenceProvider, com.compomics.util.experiment.io.biology.protein.ProteinDetailsProvider proteinDetailsProvider, com.compomics.util.experiment.mass_spectrometry.SpectrumProvider spectrumProvider, int nSurroundingAA, com.compomics.util.parameters.quantification.spectrum_counting.SpectrumCountingParameters spectrumCountingPreferences, com.compomics.util.waiting.WaitingHandler waitingHandler) throws IOException Writes an export according to the command line settings contained in the reportCLIInputBean.- Parameters:
reportCLIInputBean- the command line settingsreportType- the report typeexperiment- the experiment of the projectprojectDetails- the project details of the projectidentification- the identification of the projectgeneMaps- the gene mapsidentificationFeaturesGenerator- the identification features generatoridentificationParameters- the identification parameters usedsequenceProvider- the sequence providerproteinDetailsProvider- the protein details providerspectrumProvider- The spectrum provider.nSurroundingAA- the number of amino acids to export on the side of peptide sequencesspectrumCountingPreferences- the spectrum counting preferenceswaitingHandler- waiting handler displaying feedback to the user- Returns:
- File file containing the exported report
- Throws:
IOException- exception thrown whenever an IO exception occurred while reading or writing to a file
-
exportDocumentation
public static void exportDocumentation(ReportCLIInputBean reportCLIInputBean, String reportType, com.compomics.util.waiting.WaitingHandler waitingHandler) throws IOException Writes the documentation corresponding to an export given the command line arguments.- Parameters:
reportCLIInputBean- the command line argumentsreportType- the type of report of interestwaitingHandler- waiting handler displaying feedback to the user- Throws:
IOException- exception thrown whenever an IO exception occurred while reading or writing to a file
-
exportMzId
public static void exportMzId(MzidCLIInputBean mzidCLIInputBean, PsdbParent psbdParent, com.compomics.util.waiting.WaitingHandler waitingHandler) throws IOException Exports the project in the mzIdentML format.- Parameters:
mzidCLIInputBean- the user inputpsbdParent- a PSDB file parent allowing accessing the information it containswaitingHandler- a waiting handler allowing display of progress and interruption of the export- Throws:
IOException- exception thrown whenever an IO exception occurred while reading or writing to a file
-