Skip to content
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.

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

Add PacBio Data Transfer service #3477

Merged
merged 6 commits into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion cg/services/post_processing/abstract_classes.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ class PostProcessingDataTransferService(ABC):
def __init__(self, metrics_service: PostProcessingMetricsParser):
self.metrics_service = metrics_service

def get_post_processing_dtos(self) -> PostProcessingDTOs:
@abstractmethod
def get_post_processing_dtos(self, run_data: RunData) -> PostProcessingDTOs:
pass


Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
from cg.services.post_processing.abstract_classes import PostProcessingDataTransferService
from cg.services.post_processing.pacbio.data_transfer_service.dto import (
PacBioDTOs,
PacBioSampleSequencingMetricsDTO,
PacBioSequencingRunDTO,
PacBioSMRTCellDTO,
)
from cg.services.post_processing.pacbio.data_transfer_service.utils import (
get_sample_sequencing_metrics_dtos,
get_sequencing_run_dto,
get_smrt_cell_dto,
)
from cg.services.post_processing.pacbio.metrics_parser.metrics_parser import PacBioMetricsParser
from cg.services.post_processing.pacbio.metrics_parser.models import PacBioMetrics
from cg.services.post_processing.pacbio.run_data_generator.run_data import PacBioRunData


class PacBioDataTransferService(PostProcessingDataTransferService):

def __init__(self, metrics_service: PacBioMetricsParser):
super().__init__(metrics_service=metrics_service)
Copy link
Contributor

@seallard seallard Jul 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you calling the parent constructor like this? Seems wonky! 😄
I'd expect the constructor to look like

def __init__(self, metrics_service: PacBioMetricsParser):
    self.metrics_service = metrics_service

Also, is not the parent class abstract? It does not make sense to call the constructor of an abstract class!

Copy link
Contributor

@seallard seallard Jul 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I read some more and it might make sense to call the parent constructor if there is shared logic in the constructor, I'll leave it to you! I guess you want to enforce a strict design of the components. But maybe you can think about this a bit more.

I'm more used to interfaces which work a bit differently, only specifying the expected methods to be available on the class implementing the interface. A single class can also implement multiple interfaces

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are fixing this later on.


def get_post_processing_dtos(self, run_data: PacBioRunData) -> PacBioDTOs:
metrics: PacBioMetrics = self.metrics_service.parse_metrics(run_data)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm guessing exceptions can be thrown from the metrics parsing, should they be caught here or just bubble up?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we are fixing error handling in a later step

smrt_cell_dto: PacBioSMRTCellDTO = get_smrt_cell_dto(metrics)
sequencing_run_dto: PacBioSequencingRunDTO = get_sequencing_run_dto(metrics)
sample_sequencing_metrics_dtos: list[PacBioSampleSequencingMetricsDTO] = (
get_sample_sequencing_metrics_dtos(metrics)
)
return PacBioDTOs(
run_device=smrt_cell_dto,
sequencing_run=sequencing_run_dto,
sample_sequencing_metrics=sample_sequencing_metrics_dtos,
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
from cg.constants.devices import DeviceType
from cg.services.post_processing.pacbio.data_transfer_service.dto import (
PacBioSampleSequencingMetricsDTO,
PacBioSequencingRunDTO,
PacBioSMRTCellDTO,
)
from cg.services.post_processing.pacbio.metrics_parser.models import PacBioMetrics


def get_smrt_cell_dto(metrics: PacBioMetrics) -> PacBioSMRTCellDTO:
internal_id: str = metrics.dataset_metrics.cell_id
return PacBioSMRTCellDTO(type=DeviceType.PACBIO, internal_id=internal_id)


def get_sequencing_run_dto(metrics: PacBioMetrics) -> PacBioSequencingRunDTO:
hifi_mean_read_quality: str = f"Q{metrics.read.hifi_median_read_quality}"
return PacBioSequencingRunDTO(
type=DeviceType.PACBIO,
diitaz93 marked this conversation as resolved.
Show resolved Hide resolved
well=metrics.dataset_metrics.well,
plate=metrics.dataset_metrics.plate,
movie_time_hours=None,
hifi_reads=metrics.read.hifi_reads,
hifi_yield=metrics.read.hifi_yield,
hifi_mean_read_length=metrics.read.hifi_mean_read_length_kb,
hifi_median_read_length=metrics.read.hifi_median_read_length,
hifi_median_read_quality=hifi_mean_read_quality,
hifi_mean_length_n50=metrics.read.hifi_mean_length_n50,
percent_reads_passing_q30=metrics.read.percent_q30,
productive_zmws=metrics.productivity.productive_zmws,
p0_percent=metrics.productivity.percent_p_0,
p1_percent=metrics.productivity.percent_p_1,
p2_percent=metrics.productivity.percent_p_2,
polymerase_mean_read_length=metrics.polymerase.mean_read_length,
polymerase_read_length_n50=metrics.polymerase.read_length_n50,
polymerase_mean_longest_subread=metrics.polymerase.mean_longest_subread_length,
polymerase_longest_subread_n50=metrics.polymerase.longest_subread_length_n50,
control_reads=metrics.control.reads,
control_mean_read_length=metrics.control.mean_read_length_kb,
control_mean_read_concordance=metrics.control.percent_mean_concordance_reads,
control_mode_read_concordance=metrics.control.percent_mode_concordance_reads,
failed_reads=metrics.read.failed_reads,
failed_yield=metrics.read.failed_yield,
failed_mean_read_length=metrics.read.failed_mean_read_length_kb,
movie_name=metrics.dataset_metrics.movie_name,
diitaz93 marked this conversation as resolved.
Show resolved Hide resolved
diitaz93 marked this conversation as resolved.
Show resolved Hide resolved
)


def get_sample_sequencing_metrics_dtos(
metrics: PacBioMetrics,
) -> list[PacBioSampleSequencingMetricsDTO]:
hifi_mean_read_quality: str = f"Q{metrics.read.hifi_median_read_quality}"
sample_sequencing_metrics_dto = PacBioSampleSequencingMetricsDTO(
hifi_reads=metrics.read.hifi_reads,
hifi_yield=metrics.read.hifi_yield,
hifi_mean_read_length=metrics.read.hifi_mean_read_length_kb,
hifi_median_read_length=metrics.read.hifi_median_read_length,
hifi_median_read_quality=hifi_mean_read_quality,
percent_reads_passing_q30=metrics.read.percent_q30,
failed_reads=metrics.read.failed_reads,
failed_yield=metrics.read.failed_yield,
failed_mean_read_length=metrics.read.failed_mean_read_length_kb,
diitaz93 marked this conversation as resolved.
Show resolved Hide resolved
)
return [sample_sequencing_metrics_dto]
Loading