Overview

The development section is meant for the more advanced user of ASReview. It contains information on the technical aspects of usage, instructions for developing extensions, and an extensive API reference.

ASReview structure

ASReview provides users an API to interact directly with the underlying ASReview machinery. This provides researchers an interface to study the behavior of algorithms and develop custom workflows. The following figure shows the available interfaces for interacting with the ASReview software:

ASReview API

Development documentation

In the development documentation, the following sections are found:

  • Layer 1: API Reference

    • The ASReview API is a low level Python interface for ASReview. This interface requires detailed knowledge about the workings of the software. This reference contains extensive documentation on all functions, classes, and modules found in ASReview.

    • An outline for usage can be found in Programming Interface (API).

  • Layer 2: Command Line

    • The Command Line is an interface used to open ASReview LAB, run simulations, and run Subcommand extensions for ASReview. This development section documents all available command line options for both ASReview LAB and simulation mode.

    • For more information on using the simulation mode, see Simulation.

  • Layer 3: REST API

    • The REST API uses a Flask REST API to provide a method to let the React front-end communicate with the backend and algorithms. The REST API is not documented and should be considered ‘internal use only’.

  • Layer 4: ASReview LAB

    • ASReview is the user friendly front-end for ASReview. Documentation on LAB can be found in the ASReview LAB section.

  • Layer 5: ASReview CLOUD

    • ASReview is currently in development. For information on ASReview CLOUD, be sure visit our communication channels.

  • Section: Create an Extension

    • The Create an extension section documents the creation of model, subcommand, and dataset extensions for ASReview.

    • More information on extensions can be found in the extension Overview.