ascii

ASCII representations of retained strata.

Functions

assemblage_to_ascii(assemblage[, key, ...])	Create an ASCII table representation of HereditaryStratigraphicAssemblage state.
col_to_ascii(column[, discarded_strata, ...])	Create an ASCII table representation of HereditaryStratigraphicColumn state.

assemblage_to_ascii(assemblage: HereditaryStratigraphicAssemblage, key: bool = True, time_bookends: bool = True) → str

Create an ASCII table representation of HereditaryStratigraphicAssemblage state.

The table is oriented vertically, with the 0th column being rank and subsequent columns representing individual specimens in the assemblage.

Parameters

assemblageHereditaryStratigraphicAssemblage

The HereditaryStratigraphicAssemblage object to be converted.

keybool, default True

Append a legend to the output?

time_bookendsbool, default True

Prepend and append “MOST ANCIENT” and “MOST RECENT” to the table?

Returns

str

The ASCII representation of the HereditaryStratigraphicAssemblage object in tabular format.

col_to_ascii(column: HereditaryStratigraphicColumn, discarded_strata: bool = True, key: bool = True, time_bookends: bool = True) → str

Create an ASCII table representation of HereditaryStratigraphicColumn state.

Parameters

columnHereditaryStratigraphicColumn

The HereditaryStratigraphicColumn object to be converted.

discarded_stratabool, default True

Include discarded strata in the output?

keybool, default True

Append a legend to the output?

time_bookendsbool, default True

Prepend and append “MOST ANCIENT” and “MOST RECENT” to the table?

Returns

str

The ASCII representation of the HereditaryStratigraphicColumn object in tabular format.