Skip to content

docstrings updated #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AndrewV23 wants to merge 1 commit into
base: master
Choose a base branch
from
+22 −0
Open

docstrings updated #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions phanta/pipelines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,28 @@ def detect_reads(input_directory, config_file=None):

def assembly_pipeline(reads_class, output_dir, config_file=None, qc_only=False, stringent=False,
logger=None, logfile_location=None, logfile_configuration=None):
"""_summary_

:param reads_class: _description_
:type reads_class: _type_
:param output_dir: _description_
:type output_dir: _type_
:param config_file: _description_, defaults to None
:type config_file: _type_, optional
:param qc_only: _description_, defaults to False
:type qc_only: bool, optional
:param stringent: _description_, defaults to False
:type stringent: bool, optional
:param logger: _description_, defaults to None
:type logger: _type_, optional
:param logfile_location: _description_, defaults to None
:type logfile_location: _type_, optional
:param logfile_configuration: _description_, defaults to None
:type logfile_configuration: _type_, optional
:raises PipelineError: _description_
:raises Exception: _description_
:raises PipelineError: _description_
"""
# Setting logger if None has been passed
if logger is None:
if logfile_location is None:
Expand Down