class_docstr: A :class:`Reporter` subclass to print and store a formatted table of
  the results.
docstr: Format the table and return it as a string.
  
  Supported formatting is sorting and emphasising of the best result.
  
  Args:
      order: (optional) :obj:`str`. The order of sorting by the primary
          metric. Can be "none", "ascending" or "descending".
          Defaults to "none".
      emphasise: (optional) :obj:`bool`. Whether to emphasise the best
          experiment by marking it in yellow and blinking if supported.
          Defaults to `False`.
  
  Returns:
      :obj:`str` of the formatted table.
docstr_tok: ["Format","the","table","and","return","it","as","a","string",".","Supported","formatting","is","sorting","and","emphasising","of","the","best","result",".","Args",":","order",":","(","optional",")",":","obj",":","`","str","`",".","The","order","of","sorting","by","the","primary","metric",".","Can","be","``","none","''",",","``","ascending","''","or","``","descending","''",".","Defaults","to","``","none","''",".","emphasise",":","(","optional",")",":","obj",":","`","bool","`",".","Whether","to","emphasise","the","best","experiment","by","marking","it","in","yellow","and","blinking","if","supported",".","Defaults","to","`","False","`",".","Returns",":",":","obj",":","`","str","`","of","the","formatted","table","."]
code: def format(self, order: str = "none", emphasise: bool = False) -> str:
      """Format the table and return it as a string.
  
      Supported formatting is sorting and emphasising of the best result.
  
      Args:
          order: (optional) :obj:`str`. The order of sorting by the primary
              metric. Can be "none", "ascending" or "descending".
              Defaults to "none".
          emphasise: (optional) :obj:`bool`. Whether to emphasise the best
              experiment by marking it in yellow and blinking if supported.
              Defaults to `False`.
  
      Returns:
          :obj:`str` of the formatted table.
      """
      table_copy = self._table.copy()
      if order not in ["none", "descending", "ascending"]:
          raise ValueError(
              "`order` argument can only be 'ascending' or 'descending'."
          )
      if order != "none":
          table_copy.sort(
              key=self.primary_metric, reverse=order == "descending"
          )
      if emphasise:
          best_row_ind = int(
              np.argmax(
                  list(table_copy.get_column(self.primary_metric))
              )
          )
          emphasised_best_row = map(
              lambda x: f"\033[33;5;7m{x}\033[0m",
              table_copy[best_row_ind],
          )
          table_copy.update_row(best_row_ind, emphasised_best_row)
      return str(table_copy)
  
file_path: hypertunity/hypertunity/reports/table.py
imports: from typing import Any, List, Union
  import beautifultable
  import numpy
  import tinydb
  from hypertunity import utils
  from hypertunity.domain import Domain
  from hypertunity.optimisation.base import HistoryPoint
  from .base import Reporter
label_desc: Use image node_id 5 for calling the Table obj's underlying member method code with example usage: obj.format(order, emphasise) and returns: str