gws_omix

Introduction
Getting Started
ID Cards
Use Cases
Technical documentations
Version

Fastq folder

RESOURCE
Typing name :  RESOURCE.gws_omix.FastqFolder Brick :  gws_omix
Parent :
Folder

Folder containing fastq files

Fastq Folder file class

Views
VIEW FOLDER CONTENTDefault view
View the sub files and folders
VIEW FOLDER CONTENT
View the sub files and folders
Functions
__init__

Constructor, please do not overwrite this method, use the init method instead Leave the constructor without parameters.

path : str - ''
add_technical_info

Add technical information on the resource. Technical info are useful to set additional information on the resource.

technical_info : TechnicalInfo
technical information to add (key, value)
check_resource

You can redefine this method to define custom logic to check this resource. If there is a problem with the resource, return a string that define the error, otherwise return None This method is called on output resources of a task. If there is an error returned, the task will be set to error and next proceses will not be run. It is also call when uploading a resource (usually for files or folder), if there is an error returned, the resource will not be uploaded

Return type : Union[str, NoneType]
clone

Clone the resource to create a new instance with a new id. It copies the RFields.

Return type : ResourceType
copy_to_directory

Copy the node to the directory and keep the same base name

destination : str
_description_
Return type : str
copy_to_path

Copy this folder to the given destination

destination : str
Return type : str
create_dir_if_not_exist
dir_name : str
Return type : Path
create_empty_file_if_not_exist
file_name : str
Return type : Path
exists
get_base_name
Return type : str
get_default_name

You can redefine this method to set a name of the resource. When saving the resource the name will be saved automatically This can be useful to distinguish this resource from another one or to search for the resource

Return type : str
get_size
Return type : int
get_sub_node

Get the sub node of this folder, with the given path

sub_node_path : str
Return type : FSNode
get_sub_path

Get the path of a sub node, in the folder

sub_node_path : str
Return type : str
get_technical_info

Get the technical information of the resource

key : str
key of the technical information
Return type : TechnicalInfo
has_node
node_name : str
Return type : bool
init

This can be overwritten to perform custom initialization of the resource. This method is called just after the init (constructor) of the resource. The default values of RFields are set before this method is called.

list_dir

Return the name of files and directories inside this folder

Return type : List
list_dir_path

Return the path of files and directories inside this folder

Return type : List