DataBaseInfo#

class torch_ecg.databases.DataBaseInfo(title: str, about: str | Sequence[str], usage: Sequence[str], references: Sequence[str], note: str | Sequence[str] | None = None, issues: str | Sequence[str] | None = None, status: str | None = None, doi: str | Sequence[str] | None = None)[source]#

Bases: CitationMixin

A dataclass to store the information of a database.

title#

Title of the database.

Type:

str

about#

Description of the database.

Type:

str or list of str

usage#

Potential usages of the database.

Type:

list of str

references#

References of the database.

Type:

list of str

note#

Notes of the database.

Type:

str or list of str, optional

issues#

Known issues of the database.

Type:

str or list of str, optional

status#

Status of the database.

Type:

str, optional

doi#

DOI of the paper(s) describing the database.

Type:

str or list of str, optional

format_database_docstring(indent: str | None = None) → str[source]#

Format the database docstring from the information stored in the dataclass.

The docstring will use the reStructuredText format.

Parameters:

indent (str, optional) – Indent of the docstring. If not specified, then 4 spaces will be used.

Returns:

The formatted docstring.

Return type:

str

Note

An environment variable DB_BIB_LOOKUP can be set to True to enable the lookup of the bib entries.