asreview.open_state#

asreview.open_state(asreview_obj, review_id=None, create_new=True, check_integrety=False)[source]#

Initialize a state class instance from a project folder.

Parameters:

  • asreview_obj (str/pathlike/Project) – Filepath to the (unzipped) project folder or Project object.

  • review_id (str) – Identifier of the review from which the state will be instantiated. If none is given, the first review in the reviews folder will be taken.

  • create_new (bool) – If True, a new state file is created.

  • check_integrety (bool) – If True, the integrity of the state file is checked. Default is False.

Returns:

SQLiteState