Skip to content

FileDataset

Base class for datasets that are stored in a local file.

Small datasets that are part of the river package inherit from this class.

Parameters

  • filename

    The file's name.

  • directory

    DefaultNone

    The directory where the file is contained. Defaults to the location of the datasets module.

  • desc

    Extra dataset parameters to pass as keyword arguments.

Attributes

  • desc

    Return the description from the docstring.

  • path

Methods

take

Iterate over the k samples.

Parameters

  • k'int'