diff --git a/src/crowsetta/formats/bbox/audbbox.py b/src/crowsetta/formats/bbox/audbbox.py index fe2aca0..7a1aab2 100644 --- a/src/crowsetta/formats/bbox/audbbox.py +++ b/src/crowsetta/formats/bbox/audbbox.py @@ -96,8 +96,12 @@ def df_to_lines(df: pd.DataFrame) -> list[str]: return lines -class AudBBoxSchema(pandera.SchemaModel): - """A :class:`pandera.SchemaModel` that +class AudBBoxSchema(pandera.DataFrameModel + +): + """A :class:`pandera.DataFrameModel + +` that validates :mod:`pandas` dataframes loaded from Audacity label tracks in extended format, exported to txt files diff --git a/src/crowsetta/formats/bbox/raven.py b/src/crowsetta/formats/bbox/raven.py index 3567d17..274e201 100644 --- a/src/crowsetta/formats/bbox/raven.py +++ b/src/crowsetta/formats/bbox/raven.py @@ -17,8 +17,12 @@ from crowsetta.typing import PathLike -class RavenSchema(pandera.SchemaModel): - """A :class:`pandera.SchemaModel` that validates :type:`pandas.DataFrame`s +class RavenSchema(pandera.DataFrameModel + +): + """A :class:`pandera.DataFrameModel + +` that validates :type:`pandas.DataFrame`s loaded from a txt file, created by exporting a Selection Table from Raven. """ diff --git a/src/crowsetta/formats/seq/audseq.py b/src/crowsetta/formats/seq/audseq.py index 76df653..1541847 100644 --- a/src/crowsetta/formats/seq/audseq.py +++ b/src/crowsetta/formats/seq/audseq.py @@ -15,8 +15,12 @@ from crowsetta.typing import PathLike -class AudSeqSchema(pandera.SchemaModel): - """A :class:`pandera.SchemaModel` +class AudSeqSchema(pandera.DataFrameModel + +): + """A :class:`pandera.DataFrameModel + +` that validates :type:`pandas.DataFrame`s loaded from Audacity Labeltrack annotations exported to txt files in the standard format. diff --git a/src/crowsetta/formats/seq/generic.py b/src/crowsetta/formats/seq/generic.py index 0208ff8..c856038 100644 --- a/src/crowsetta/formats/seq/generic.py +++ b/src/crowsetta/formats/seq/generic.py @@ -35,8 +35,12 @@ """ -class GenericSeqSchema(pandera.SchemaModel): - """A :class: `pandera.SchemaModel` that validates +class GenericSeqSchema(pandera.DataFrameModel + +): + """A :class: `pandera.DataFrameModel + +` that validates :type:`pandas.DataFrame`s loaded from a csv file in the ``'generic-seq'`` annotation format. diff --git a/src/crowsetta/formats/seq/simple.py b/src/crowsetta/formats/seq/simple.py index 6d2cf75..69f8ac1 100644 --- a/src/crowsetta/formats/seq/simple.py +++ b/src/crowsetta/formats/seq/simple.py @@ -30,8 +30,12 @@ from crowsetta.typing import PathLike -class SimpleSeqSchema(pandera.SchemaModel): - """A :class:`pandera.SchemaModel` +class SimpleSeqSchema(pandera.DataFrameModel + +): + """A :class:`pandera.DataFrameModel + +` that validates :type:`pandas.DataFrame`s loaded from a csv or txt file in a 'simple-seq' format. diff --git a/src/crowsetta/formats/seq/timit.py b/src/crowsetta/formats/seq/timit.py index b48ec83..90085ff 100644 --- a/src/crowsetta/formats/seq/timit.py +++ b/src/crowsetta/formats/seq/timit.py @@ -19,8 +19,12 @@ from crowsetta.typing import PathLike -class TimitTranscriptSchema(pandera.SchemaModel): - """A :class:`pandera.SchemaModel` that validates :type:`pandas.DataFrame`s +class TimitTranscriptSchema(pandera.DataFrameModel + +): + """A :class:`pandera.DataFrameModel + +` that validates :type:`pandas.DataFrame`s loaded from a phn or wrd file in the TIMIT[1]_ transcription format. References