actsnclass.Canonical.snpcc_get_canonical_info¶
-
Canonical.
snpcc_get_canonical_info
(path_to_rawdata_dir: str, canonical_output_file: str, compute=True, save=True, canonical_input_file='')¶ Load SNPCC metada data required to characterize objects.
Populates attribute: data.
Parameters: - path_to_rawdata_dir (str) – Complete path to directory holding raw data files.
- canonical_output_file (str) – Complete path to output canonical sample file.
- compute (bool (optional)) – Compute required metada from raw data files. Default is True.
- save (bool (optional)) – Save metadata to file. Default is True.
- canonical_input_file (str (optional)) – Path to input file if required metadata was previously calculated. If name is give, ‘compute’ must be False.