pandera.api.pandas.container.DataFrameSchema.example#

DataFrameSchema.example(size=None, n_regex_columns=1)[source]#

Generate an example of a particular size.

Parameters: size (Optional[int]) – number of elements in the generated DataFrame.
Return type: DataFrame
Returns: pandas DataFrame object.