oktoberfest.pp.convert_timstof_metadata
- oktoberfest.pp.convert_timstof_metadata(input_path, search_engine, output_file=None)
Convert metadata for timstof to Oktoberfest format.
Given a path to a directory containing search results from supported search engines, the function parses, converts metadata relevant for timstof to the internal format used by Oktoberfest and returns it as a dataframe. If a path to an output file is provided, the converted results are also stored to the specified location.
- Parameters:
input_path (
Union[str,Path]) – Path to the directory or file containing the metadata.search_engine (
str) – The search engine used to produce the search results, currently supported is “Maxquant”output_file (
Union[str,Path,None]) – Optional path to the location where the converted metadata should be written to. If this is omitted, the metadata are not stored.
- Raises:
ValueError – if an unsupported search engine was given
- Return type:
- Returns:
dataframe containing metadata that maps scan numbers to precursors