arviz_base.citations

Contents

arviz_base.citations#

arviz_base.citations(methods=None, filepath=None, format_type='bibtex')[source]#

List citations for ArviZ and the methods implemented in ArviZ.

Parameters:
methodsCallable or list of callable, optional

Methods implemented in ArviZ from which to retrieve citations.

filepathstr, optional

Specifies the location to save the file with the citations. If None, the result is returned as a string.

format_typestr

Specifies in which format the references will be displayed. Currently, only “bibtex” is supported.

Examples

>>> from arviz_base import citations
>>> from arviz_stats import rhat
>>> citations(methods=[rhat])  # Returns how to cite ArviZ and rhat
>>> citations()  # Returns how to cite ArviZ
Contents