MatrixReport.from_file#
- classmethod MatrixReport.from_file(path, *, translation_path=None, translation_from_col=None, translation_to_col=None, translation_factors_col=None)[source]#
Create an instance of MatrixReport from file paths.
- Parameters:
path (pathlib.Path) – Path to the matrix csv.
translation_path (Optional[pathlib.Path], optional) – Path to correspondence between matrix zoning and summary zoning, by default None
translation_from_col (Optional[str], optional) – The column in the translation matrix with zoning to translate from, by default None.
translation_to_col (Optional[str], optional) – The column in the translation matrix with zoning to translate to, by default None.
translation_factors_col (Optional[str], optional) – The column in the translation matrix to use as factors, by default None.
- Returns:
Instance of MatrixReport created from the file paths.
- Return type: