asreview.data.RISWriter#

class asreview.data.RISWriter[source]#

Bases: object

RIS file writer.

Methods

__init__()

write_data(df, fp)

Export dataset.

Attributes

caution

label

name

write_format

caution = 'Available only if you imported a RIS file when creating the project'#
label = 'RIS'#
name = 'ris'#
classmethod write_data(df, fp)[source]#

Export dataset.

Parameters:

  • df (pd.Dataframe) – Dataframe of all available record data.

  • fp (str, pathlib.Path) – File path to the RIS file, if exists.

Returns:

RIS file – Dataframe of all available record data. Any column from the data frame that starts with asreview_ is added to the RIS file as note in the notes field of the form: asreview_{column_name}: json.dumps({column_value}). If the dataframe contains a column asreview_label, also a note is added with the value ASReview_relevant, ASReview_irrelevant or ASReview_not_seen corresponding to the value 1, 0 or None in that column.

write_format = '.ris'#