immuneML.reports.clustering_reports package¶
Submodules¶
immuneML.reports.clustering_reports.ClusteringReport module¶
- class immuneML.reports.clustering_reports.ClusteringReport.ClusteringReport(name: str = None, result_path: Path = None, number_of_processes: int = 1, state: ClusteringState = None)[source]¶
Bases:
Report- classmethod build_object(**kwargs)[source]¶
Creates the object of the subclass of the Report class from the parameters so that it can be used in the analysis. Depending on the type of the report, the parameters provided here will be provided in parsing time, while the other necessary parameters (e.g., subset of the data from which the report should be created) will be provided at runtime. For more details, see specific direct subclasses of this class, describing different types of reports.
- Parameters:
**kwargs – keyword arguments that will be provided by users in the specification (if immuneML is used as a command line tool) or in the dictionary when calling the method from the code, and which should be used to create the report object
- Returns:
the object of the appropriate report class