expyriment.io.DataFile
- class expyriment.io.DataFile(additional_suffix, directory=None, delimiter=None, time_stamp=None)
A class implementing a data file.
- __init__(additional_suffix, directory=None, delimiter=None, time_stamp=None)
Create a data file.
Filename: {MAINFILE_NAME}_{SUBJECT_ID}_{TIME_STAMP}{ADD_SUFFIX}.xpd
- Parameters:
- additional_suffixstr
additional suffix
- directorystr, optional
directory of the file
- delimiterstr, optional
symbol between variables
- time_stampbool, optional
using time stamps, based on the experiment start time, not the current time
- add(data)
Add data.
- Parameters:
- datastring or numeric or list
data to be added
- add_experiment_info(text)
Adds a text the subject info header.
- Parameters:
- textstr
experiment information to be added to the file header
Notes
The next data.save() might take longer!
- add_subject_info(text)
Adds a text the subject info header.
Subject information can be extracted afterwards using misc.data_preprocessing.read_data_file. To defined between subject variables use a syntax like this: “gender = female” or “handedness : left”
- Parameters:
- textstr
subject information to be added to the file header
Notes
The next data.save() might take longer!
- add_variable_names(variable_names)
Add data variable names to the data file.
- Parameters:
- variablesstr or list of str
variable names
Notes
The next data.save() might take longer!
- clear_variable_names()
Remove all variable names from data file.
Notes
The next data.save() might take longer!
- property comment_char
Getter for comment_char
- property delimiter
Getter for delimiter
- property directory
Getter for directory
- property filename
Getter for filename
- property fullpath
Getter for fullpath
- static get_next_subject_number()
Return the next subject number based on the existing data and event files.
- property logging
Getter for logging.
- rename(new_filename)
Renames the output file.
- save()
Save the new data to data-file.
- Returns:
- timeint
the time it took to execute this method
- set_logging(onoff)
Set logging of this object on or off
- Parameters:
- onoffbool
set logging on (True) or off (False)
- property standard_file_name
Getter for the standard expyriment outputfile name.
Filename: {MAINFILE_NAME}_{SUBJECT_ID}_{TIME_STAMP}{suffix}
- property suffix
Getter for directory
- property variable_names
Getter for variable_names.
- write(content)
Write to file.
- Parameters:
- contentstr
content to be written (anything, will be casted to str)
- write_comment(comment)
Write a comment line to files.
(i.e., text is proceeded by comment char).
- Parameters:
- commentstr
comment to be written (anything, will be casted to str)
- write_line(content)
Write a text line to files.
- Parameters:
- contentstr
content to be written (anything, will be casted to str)
- write_list(list_)
Write a list in a row. Data are separated by a delimiter.
- Parameters:
- list_list
list to be written