pytexutils.tables.table

  1import numpy as np
  2
  3def table(columns_name : list, data : np.ndarray, round_val : int = 4, bold_axis : int = None, caption : str = "table_caption", label : str = "table_label", preamble : bool = False) -> str:
  4    '''
  5        Produces LaTeX code to display a table.
  6
  7        Parameters:  
  8        -----------
  9        - columns_name  
 10            list of strings containing table columns name
 11        - data : np.ndarray
 12            2D ndarray containing data used to fill the table
 13        - round_val : int
 14            integer representing the decimal rounding
 15        - bold_axis : int
 16            integer representing the axis to wich get the max value and to set bold, if None no bold text will be added
 17            if 0 the maximum will be calculated column-wise, if 1 the maximum will be calculated row-wise
 18        - caption : str  
 19            string for the caption of LaTeX table (default: "table_caption")  
 20        - label : str  
 21            string for the label of LaTeX table (default: "table_label")  
 22        - preamble : bool  
 23            If True the function will return a full LaTeX document, if False the function will return only the table (default: False)  
 24
 25        Returns:  
 26        --------  
 27        - p : str  
 28            LaTeX code to display a table  
 29
 30        Usage:
 31        ------
 32
 33        ```python
 34        import numpy as np  
 35
 36        columns_name = ['A', 'B', 'C']  
 37        data         = np.array(  
 38            [  
 39                [0.1, 0.2, 0.3],  
 40                [0.4, 0.5, 0.6],  
 41                [0.7, 0.8, 0.9]  
 42            ]  
 43        )  
 44
 45        latex_table = table(columns_name, data, caption='My table 1', label='tab1', preamble=True)
 46        ```
 47
 48        Output:
 49        -------
 50
 51        ```latex
 52        \\documentclass[11pt]{article}
 53        \\usepackage{booktabs}
 54        \\usepackage{graphicx}
 55
 56        \\begin{document}
 57
 58        \\begin{table}[!ht]
 59                \\centering
 60                \\caption{My table 1}\\label{tab:tab1}
 61                \\resizebox{\\columnwidth}{!}{
 62                \\begin{tabular}{ccc}
 63                        \\toprule
 64                            A     &     B     &     C     \\\\
 65                        \\midrule
 66                            0.1     &     0.2     &     0.3     \\\\
 67                            0.4     &     0.5     &     0.6     \\\\
 68                            0.7     &     0.8     &     0.9     \\\\
 69                            1.1     &     1.2     &     1.3     \\\\
 70                        \\bottomrule
 71                \\end{tabular}}
 72        \\end{table}
 73
 74        \\end{document}
 75        ```
 76    '''
 77
 78    if len(data.shape) != 2:
 79        raise Exception("Error Message: shape of data must be equals to two.")
 80
 81    if columns_name is not None: 
 82        if data.shape[1] != len(columns_name):
 83            raise Exception("Error Message: mismatch between number of columns and shape of data")
 84        
 85    if round_val < 1:
 86        round_val = 1
 87
 88    if bold_axis is not None:
 89        if bold_axis < 0 or bold_axis > 1:
 90            bold_axis = None
 91    
 92    p = ""
 93    # LaTeX preamble
 94    if preamble:
 95        p += "\\documentclass[11pt]{article}\n"
 96        p += "\\usepackage{booktabs}\n"
 97        p += "\\usepackage{graphicx}\n\n"
 98        p += "\\begin{document}\n\n"
 99
100    # Table
101    p += "\\begin{table}[!ht]\n"
102    p += "\t\\centering\n"
103    p += "\t\\caption{"+str(caption)+"}\\label{tab:"+label+"}\n"
104    p += "\t\\resizebox{\\columnwidth}{!}{\n"
105    p += "\t\\begin{tabular}{" + "".join([char*data.shape[1] for char in "c"]) + '}\n'
106    p += "\t\t\\toprule\n"
107
108    if columns_name is not None:
109        # Columns name
110        l = "\t\t"
111        for i in range(len(columns_name)):
112            l+= "{:<1s}{}{:<1s}{}".format("", str(columns_name[i].strip()), "", "&")
113        l = l[:-1]
114        p += l + "\\\\\n"
115        p += "\t\t\\midrule\n"
116
117    if bold_axis is not None:
118
119        new_data_min = []
120        new_data_max = []
121        for x in range(data.shape[0]):
122            dmin = []
123            dmax = []
124            for y in range(data.shape[1]):
125                try:
126                    dmin.append(float(data[x,y]))
127                    dmax.append(float(data[x,y]))
128                except Exception:
129                    dmin.append(+1e100)
130                    dmax.append(-1e100)
131            new_data_min.append(dmin)
132            new_data_max.append(dmax)
133        
134        new_data_min = np.array(new_data_min).astype(float)
135        new_data_max = np.array(new_data_max).astype(float)
136        min_pos = np.nanargmin(new_data_min, axis=bold_axis)
137        max_pos = np.nanargmax(new_data_max, axis=bold_axis)
138
139    # Data
140    for i in range(data.shape[0]):
141        l = "\t\t"
142        for j in range(data.shape[1]):
143
144            d = data[i,j]
145            if type(d) is float: d = round(d, round_val)
146            d = str(d).strip()
147            
148            if bold_axis is None:
149                l+= "{:<1s}{}{:<1s}{}".format("", d, "", "&")
150            elif bold_axis == 0:
151                if min_pos[j] == i:
152                    l+= "{:<1s}{}{:<1s}{}".format("", "\\bfseries{"+d+"}", "", "&")
153                elif max_pos[j] == i:
154                    l+= "{:<1s}{}{:<1s}{}".format("", "\\textit{"+d+"}", "", "&")
155                else:
156                    l+= "{:<1s}{}{:<1s}{}".format("", d, "", "&")
157            elif bold_axis == 1:
158                if min_pos[i] == j:
159                    l+= "{:<1s}{}{:<1s}{}".format("", "\\bfseries{"+d+"}", "", "&")
160                elif max_pos[i] == j:
161                    l+= "{:<1s}{}{:<1s}{}".format("", "\\textit{"+d+"}", "", "&")
162                else:
163                    l+= "{:<1s}{}{:<1s}{}".format("", d, "", "&")
164
165        l = l[:-1]
166
167        p += l + "\\\\\n"
168    p += "\t\t\\bottomrule\n"
169    p += "\t\\end{tabular}}\n"
170    p += "\\end{table}\n"
171
172    if preamble:
173        # End document
174        p += "\n\\end{document}\n"
175
176    return p