bigframes.pandas.Series.to_markdown

Series.to_markdown(buf: IO[str] | None = None, mode: str = 'wt', index: bool = True, *, allow_large_results: bool | None = None, **kwargs) → str | None

Print Series in Markdown-friendly format.

Examples:

>>> s = bpd.Series(["elk", "pig", "dog", "quetzal"], name="animal")
>>> print(s.to_markdown())
|    | animal   |
|---:|:---------|
|  0 | elk      |
|  1 | pig      |
|  2 | dog      |
|  3 | quetzal  |

Output markdown with a tabulate option.

>>> print(s.to_markdown(tablefmt="grid"))
+----+----------+
|    | animal   |
+====+==========+
|  0 | elk      |
+----+----------+
|  1 | pig      |
+----+----------+
|  2 | dog      |
+----+----------+
|  3 | quetzal  |
+----+----------+

Parameters:

• buf (str, Path or StringIO-like, optional, default None) – Buffer to write to. If None, the output is returned as a string.

• mode (str, optional) – Mode in which file is opened, “wt” by default.

• allow_large_results (bool, default None) – If not None, overrides the global setting to allow or disallow large query results over the default size limit of 10 GB.

• index (bool, optional, default True) – Add index (row) labels.

Returns:

Series in Markdown-friendly format.

Return type:

str