Function main

doc/code_examples/ExamplePlugin.py:14–55

()

-no_progress : flag to disable output to command line
'''
def main():
    parser = argparse.ArgumentParser(description="Test tool for prototyping TOPPView-plugins")
    parser.add_argument("-write_ini", help="Writes ini to specified path and exits.")
    parser.add_argument("-ini", help="The ini file to load")
    parser.add_argument("-in", help="The input file")
    parser.add_argument("-out", help="The output file")
    parser.add_argument("-no_progress", action="store_false", help="Turn of output to the command line")

    args = vars(parser.parse_args())

    ini_path = args["write_ini"]

    # create ini at path
    if ini_path is not None:
        # create the default parameters
        param = Param()
        # this will create the param structure that is mandatory for all plugins
        param.initPluginParam("ExamplePlugin", "0.0.1")
        # the valid input fileformats have to be added like this
        param.setValidStrings("ExamplePlugin:1:in", [b"*.mzML"])

        # additional parameters can be added like this
        param.setValue("ExamplePlugin:1:Number", 0, "This is an additional numeric parameter")
        param.setValue("ExamplePlugin:1:Text", "example 1", "This is an additional text parameter")
        param.setValidStrings("ExamplePlugin:1:Text", [b"option 1", b"option 2", b"option 3"])
        param.setValue("ExamplePlugin:1:Required", "", "This is an additional required parameter", [b"required"])

        # write them to the given filepath
        file = ParamXMLFile()
        file.store(ini_path, param)

        exit()

    # this is an example for loading and saving an experiment from a mzML file
    MzML = MzMLFile()
    exp = MSExperiment()

    input_file = args["in"]
    output_file = args["out"]
    MzML.load(input_file, exp)
    # we save it here without doing anything
    MzML.store(output_file, exp)

    
if __name__ == "__main__":