asreview.ASReviewProject

class asreview.ASReviewProject(project_path, project_id=None)[source]

Project class for ASReview project files.

Attributes

config

feature_matrices

reviews

Methods

add_dataset(file_name)

Add file path to the project file.

add_feature_matrix(feature_matrix, ...)

Add feature matrix to project file.

add_review(review_id[, start_time, status])

Add new review metadata.

clean_tmp_files()

Clean temporary files in a project.

create(project_path[, project_id, ...])

Initialize the necessary files specific to the web app.

delete_review([remove_folders])

export(export_fp)

get_feature_matrix(feature_extraction_method)

Get the feature matrix from the project file.

load(asreview_file, project_path[, safe_import])

mark_review_finished([review_id])

Mark a review in the project as finished.

read_data([use_cache, save_cache])

Get ASReviewData object from file.

remove_dataset()

Remove dataset from project.

remove_error(status)

set_error(err[, save_error_message])

update_config(**kwargs)

Update project info

update_review([review_id])

Update review metadata.