33# auto_processor.py: automated processing of Illumina sequence data
44# Copyright (C) University of Manchester 2013-2026 Peter Briggs
55#
6- #########################################################################
7- #
8- # auto_processor.py
9- #
10- #########################################################################
116
127#######################################################################
138# Imports
2419import gzip
2520import atexit
2621import bcftbx .IlluminaData as IlluminaData
27- import bcftbx .TabFile as TabFile
2822import bcftbx .utils as bcf_utils
29- import bcftbx .htmlpagewriter as htmlpagewriter
30- from bcftbx .JobRunner import fetch_runner
31- from bcftbx .FASTQFile import FastqIterator
3223from .analysis import AnalysisProject
3324from .analysis import run_id
3425from .analysis import run_reference_id
3930from .utils import get_numbered_subdir
4031from .utils import sort_sample_names
4132from .bcl2fastq .utils import get_sequencer_platform
42- from .samplesheet_utils import check_and_warn
4333from .settings import Settings
4434from .exceptions import MissingParameterFileException
4535from functools import reduce
46- from . import get_version
4736
4837#######################################################################
4938# Classes
@@ -55,24 +44,28 @@ class AutoProcess:
5544 Class implementing an automatic fastq generation and QC
5645 processing procedure for Illumina sequencing data
5746
47+ The 'AutoProcess' class provides an interface to a directory
48+ being used for processing Illumina sequencing data, including
49+ Fastq generation and QC operations.
50+
51+ The auto_process data processing and QC pipelines are
52+ constructed around this class, which allows the current state
53+ of the processing directory (and associated metadata) to be
54+ accessed and modified.
55+
56+ Arguments:
57+ analysis_dir (str): name/path for existing analysis
58+ directory
59+ settings (Settings): optional, if supplied then should
60+ be a Settings instance; otherwise use a default
61+ instance populated from the installation-specific
62+ 'auto_process.ini' file
63+ allow_save_params (bool): if True then allow updates
64+ to parameters to be saved back to the parameter file
65+ (this is the default)
5866 """
5967 def __init__ (self ,analysis_dir = None ,settings = None ,
6068 allow_save_params = True ):
61- """
62- Create a new AutoProcess instance
63-
64- Arguments:
65- analysis_dir (str): name/path for existing analysis
66- directory
67- settings (Settings): optional, if supplied then should
68- be a Settings instance; otherwise use a default
69- instance populated from the installation-specific
70- 'auto_process.ini' file
71- allow_save_params (bool): if True then allow updates
72- to parameters to be saved back to the parameter file
73- (this is the default)
74-
75- """
7669 # Initialise
7770 self ._master_log_dir = "logs"
7871 self ._log_dir = self ._master_log_dir
0 commit comments