Retriever¶
- mutalyzer_retriever.retriever.retrieve_model(reference_id, reference_source=None, reference_type=None, size_off=True, model_type='all', timeout=1)¶
Obtain the model of the provided reference id.
- Parameters:
reference_id (str) – The id of the reference to retrieve.
reference_source (str) – A dedicated retrieval source.
reference_type (str) – A dedicated retrieval type.
size_off (bool) – Download large files.
timeout (float) – Timeout.
- Returns:
Reference model.
- Return type:
dict
- mutalyzer_retriever.retriever.retrieve_model_from_file(paths=[], is_lrg=False)¶
- Parameters:
paths (list) – Path towards the gff3, fasta, or lrg files.
is_lrg (bool) – If there is only one file path of an lrg.
- Returns:
Reference model.
- Return type:
dict
- mutalyzer_retriever.retriever.retrieve_raw(reference_id, reference_source=None, reference_type=None, size_off=True, timeout=1)¶
Retrieve a reference based on the provided id.
- Parameters:
reference_id (str) – The id of the reference to retrieve.
reference_source (str) – A dedicated retrieval source.
reference_type (str) – A dedicated retrieval type.
size_off (bool) – Download large files.
timeout (float) – Timeout.
- Returns:
Reference content.
- Return type:
str