Skip to content

Commit

Permalink
Clarify output type
Browse files Browse the repository at this point in the history
  • Loading branch information
HanaJaafari committed Jul 1, 2024
1 parent 58a3eff commit 8340f1d
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions frustratometer/filter/filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@
import logging
logger = logging.getLogger(__name__)

def filter_alignment(alignment_file,
output_file = None,
alignment_format = "stockholm"):
def filter_alignment(alignment_file:str,
output_file:str = None,
alignment_format:str = "stockholm")->Path:
"""
Filter stockholm alignment by removing unaligned sections.
Filters by saving the alignment into memory.
Parameters
----------
alignment_file : Path
alignment_file : str
location of file
output_file : Path
output_file : str
location of the output_file
alignment_format : str
Biopython alignment format (Default: stockholm)
Expand Down Expand Up @@ -64,24 +64,24 @@ def filter_alignment(alignment_file,
return output_file


def filter_alignment_lowmem(alignment_file,
output_file,
alignment_format = "stockholm"):
def filter_alignment_lowmem(alignment_file:str,
output_file:str,
alignment_format:str = "stockholm")->Path:
"""
Filter stockholm alignment by removing unaligned sections.
Filters by reading the file without saving to memory.
Parameters
----------
alignment_file : Path
alignment_file : str
location of file
output_file : Path
output_file : str
location of the output_file
alignment_format : str
Biopython alignment format (Default: stockholm)
Returns
-------
output_file : Path
output_file : str
location of the output_file
"""
#TODO: Implement filter query for jackhmmer
Expand Down

0 comments on commit 8340f1d

Please sign in to comment.