Metadata
- class metadata.Metadata(metadata_file, metadata, version, dataset_path)
Bases:
object- add_values(element, values)
Append values to the last value
- Parameters:
element (str) – a col/row name in Excel
values (list | str | int | bool) – element values from that metadata
- Returns:
- clear_values(element='')
- Parameters:
element (str) – Unique row/col name in Excel. (Ex: if subjects is metadata_file, a row name can be a unique subjet id)
- Returns:
- get_values(element)
- Parameters:
element – a col/row name in Excel
- Returns:
- remove_row(value)
- remove_values(element, values)
- Parameters:
values (list | str | int | bool) – field value
element (str) – Unique row/col name in Excel.
- Returns:
- save(path='')
Save the metadata file to dataset dir
- Parameters:
path (str) – the dataset root path (Optional)
- set_col_values(col_index, values, append=True)
Set col fields/values by col index :param values: field values :type values: list | str | int | bool :param col_index: the header index :type col_index: int :param append: insert values into last col or row :type append: bool :return:
- set_row_values(row_index, values, col_name='Value', append=True)
Set row fields/values by row idx/name and column name (the header)
- Parameters:
row_index (int) – row index in Excel. Excel index starts from 1 where index 1 is the header row. so actual data index starts from 2
col_name (str) – column name. the header is the first row
values (list | str | int | bool) – field values
append (bool) – insert values into last col or row
- Returns:
updated dataset
- Return type:
dict
- set_values(element, values)
Override the values in that element
- Parameters:
element (str) – a col/row name in Excel
values (list | str | int | bool) – element values from that metadata
- Returns:
- validate_input(element, elements)
- Parameters:
element – row/col name in excel
elements – dataset metadata elements
- Returns:
- class metadata.Sample
Bases:
object- add_path(source_path)
Add sample source path to sample object
- Parameters:
source_path (str | list) – sample folder source path
- count = 0
- get_sample_id()
Get sample id :return: sample id
- move()
Move sample files from source dir to dataset primary dir
- remove_values()
Future function
- save()
Save sample metadata file
- set_path(source_path)
Add sample source path to sample object Override the Previous path
- Parameters:
source_path (str | list) – sample folder source path
- set_subject_id(sub_id)
set subject id to sample object :param sub_id: a subject id :type sub_id: str
- set_value(element, value)
Set value for one element for a sample
- Parameters:
element (str) – element in sample metadata file
value (str|int) – the values for that element
- set_values(metadata={})
- Parameters:
metadata (dict) – key : value dict (element:value)
- class metadata.Subject
Bases:
object- add_samples(samples)
Add samples into subject object
- Parameters:
samples (list) – a samples list
- count = 0
- get_sample(sample_sds_id) Sample
Provide the sample sds id to query a sample for edit
- Parameters:
sample_sds_id – the sample id in sds
- Returns:
Sample
- move()
- remove_values()
- save()
- set_value(element, value)
Set value for one element for a subject
- Parameters:
element (str) – element in sample metadata file
value (str|int) – the values for that element
- set_values(metadata={})
- Parameters:
metadata (dict) – key : value dict (element:value)