coretex.entities.sample.sequence_sample.sequence_sample.SequenceSample Class Reference

Inheritance diagram for coretex.entities.sample.sequence_sample.sequence_sample.SequenceSample:

Public Member Functions
bool	isValidSequenceFile (cls, Union[Path, str] path)
Public Member Functions inherited from coretex.entities.sample.network_sample.NetworkSample
Path	path (self)
Path	zipPath (self)
Path	downloadPath (self)
bool	modifiedSinceLastDownload (self)
None	decrypt (self, bool ignoreCache=False)
None	download (self, bool decrypt=True, bool ignoreCache=False)
None	unzip (self, bool ignoreCache=False)
Public Member Functions inherited from coretex.entities.sample.sample.Sample
Path	joinPath (self, Union[Path, str] other)
Public Member Functions inherited from coretex.entities.sample.sequence_sample.local_sequence_sample.LocalSequenceSample
Path	sequencePath (self)
Path	forwardPath (self)
Path	reversePath (self)
None	unzip (self, bool ignoreCache=False)
bool	isPairedEnd (self)
Public Member Functions inherited from coretex.entities.sample.local_sample.LocalSample
Path	path (self)
Path	zipPath (self)
None	download (self, bool decrypt=True, bool ignoreCache=False)

Detailed Description

    Represents the local custom Sample class
    which is used for working with Other Task locally

Definition at line 25 of file sequence_sample.py.

Member Function Documentation

isValidSequenceFile()

bool coretex.entities.sample.sequence_sample.sequence_sample.SequenceSample.isValidSequenceFile	(		cls,
		Union[Path, str]	path
	)

    Checks whether the file is a valid sequence file or not.
    File is a valid sequence file if it ends with any of these extensions:
        - .fasta
        - .fastq
        - .fa
        - .fq

Definition at line 36 of file sequence_sample.py.

    def isValidSequenceFile(cls, path: Union[Path, str]) -> bool:
        """
            Checks whether the file is a valid sequence file or not.
            File is a valid sequence file if it ends with any of these extensions:
                - .fasta
                - .fastq
                - .fa
                - .fq
        """
 
        if not isinstance(path, Path):
            path = Path(path)
 
        supportedExtensions = cls.supportedExtensions()
        supportedExtensions.extend([f"{extension}.gz" for extension in cls.supportedExtensions()])
 
        return any(path.name.endswith(extension) for extension in supportedExtensions)

---

The documentation for this class was generated from the following file:

• coretex/entities/sample/sequence_sample/sequence_sample.py