Method ShowMdString

Namespace

SparkTest.NET.Extensions

Assembly

SparkTest.NET.dll

ShowMdString(DataFrame, int, int, bool, bool, bool, bool)

Displays rows of the DataFrame in tabular form in common mark format

[Since("2.4.0")]
public static string ShowMdString(this DataFrame dataFrame, int numRows = 20, int truncate = 0, bool vertical = false, bool showResults = true, bool showSchema = true, bool showPlan = true)

Parameters

dataFrame DataFrame

DataFrame

numRows int

number of rows to show

truncate int

if set to more than 0, truncates strings to truncate characters and all cells will be aligned right

vertical bool

If set to true, prints output rows vertically (one line per column value)

showResults bool

flag to indicate that results should be included in the output

showSchema bool

flag to indicate that schema should be included in the output

showPlan bool

flag to indicate that plan should be included in the output

Returns

string

row data in markdown format

Remarks

Used to include DataFrame results in markdown documentation