Login
Back to bricks list
Introduction 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 CONTENT - view_as_json()Default view
View the sub files and folders
VIEW FOLDER CONTENT - view_sub_file()
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.

Parameters:
NameTypeDefault valueDescription
pathstr ''
ADD_TECHNICAL_INFO

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

Parameters:
NameTypeDefault valueDescription
technical_infoTechnicalInfo 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

Parameters:
NameTypeDefault valueDescription
destinationstr _description_
Return type:
str
COPY_TO_PATH

Copy this folder to the given destination

Parameters:
NameTypeDefault valueDescription
destinationstr
Return type:
str
CREATE_DIR_IF_NOT_EXIST
Parameters:
NameTypeDefault valueDescription
dir_namestr
Return type:
Path
CREATE_EMPTY_FILE_IF_NOT_EXIST
Parameters:
NameTypeDefault valueDescription
file_namestr
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

Parameters:
NameTypeDefault valueDescription
sub_node_pathstr
Return type:
FSNode
GET_SUB_PATH

Get the path of a sub node, in the folder

Parameters:
NameTypeDefault valueDescription
sub_node_pathstr
Return type:
str
GET_TECHNICAL_INFO

Get the technical information of the resource

Parameters:
NameTypeDefault valueDescription
keystr Key of the technical information
Return type:
TechnicalInfo
HAS_NODE
Parameters:
NameTypeDefault valueDescription
node_namestr
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