Working on a Project

Finishing the project creation wizard by pressing the “Save and Close” button, the project will be stored on the server (in the respectively selected/provided database file). As not all steps are mandatory, this can be done at any part of the process, and users can then add more stages, keywords or any other value via the editing options at a later point in time.

Created, the user can now select the Projects Overview tab to refresh the list of active projects. This presents the list of available projects including the recently created one (Figure 10).

Figure 10 The project overview screen.

Figure 11 The project action screen.

Double-clicking the project will lead to the Project Details window (Figure 11), where the meta-data is
displayed, as well as the options available for working on the project; including:
  • General editing (for project meta-data)
  • General reporting
  • BibTeX generation for the entire article library in the project
  • Adding BibTeX files
  • Seeing the current results for completed stages
  • Pruning articles, removing all voted against by a majority
  • General work on the project

Add Literature to the Database

First, the user should add the found literature to the project. This is done by either pasting plain BibTeX text as input into the textbox and clicking “Add BibTeX”, or by clicking the “Add BibTeX File” button to browse to the BibTeX file to be uploaded and process it. The latter is the most convenient, while the textbox is mainly there to manually add pieces of later-found literature (to incrementally extend the database, e.g., when updating a literature study). It is functionally identical to importing a BibTeX file. Selecting the “Add BibTeX File” button presents the user with a file browser window and navigating to the bib file and clicking “OK” sends it to the server, where it is processed and transformed into (internal) Article objects, which a used in the project as general computable data format.

At the bottom, all saved information is displayed regarding the project. Edit buttons lead the user to edit pages for each sections information where more can be added.

NOTE: Currently, it is not possible to edit already saved information, as this can lead to issues with the study.

Start the Study Selection

Once articles have been added to a project, work can be start. Clicking the Work on Project button opens the window for working with articles (Figure 12).

Figure 12 Publication selection and classification screen.

Here, any duplicates can be checked in the “Duplicate” column and then removed by clicking the “Remove
Duplicates” button. Articles remaining can then be selected, with their meta-information appearing on the righthand side. Each phase (or stage) also appears with the appropriate options as radio buttons. Each selection is persisted immediately.

Reviewing the Project Status

At times it can be interesting to see what results other users have selected. Going back to the Project Overview page, the users can click the ”Stage Results” button. This opens the window in Figure 13, where a summary shows the current selections by each user for each article. Here, each article is listed along with columns for each user and each stage, where selections made by the users are displayed, so the project moderator can review current status and progress.

Figure 13 Viewing in-project reports.

Cleaning the Dataset

Once the initial stages have been completed by all users (voting articles in or out), clicking the ”Remove
Articles Voted Out” button will move all articles considered irrelevant to the study to a separate list, saving the information for them, but after this, these will no longer appear in the ”Work on Project” window, thinning the list down to only relevant articles for the user to work on.

Note: The information is not lost and can be “retrieved” from the database at any time.

Preparing Exports and Reports

Reports can be generated from the Project Details window (Figure 14). By default, so far, LiSA exports CSV and BibTeX files for further processing in external tools (Further export formats and in-tool-processing are subject to future development).

Figure 14 Standard export files from a project.

Currently, two reports are offered: the Meta-data Report (Figure 15) and the Full Report (Figure 16).
The Meta-data Report reports on the number of articles in each database, i.e., how many were accepted vs. how many were rejected.

Figure 15 Overview of data contained in the meta-report (study overview).

The Full Report generates a CSV file that translates the LiSA-internal database structure and the current project data into a plain spreadsheet-compatible format, e.g., to be used with Microsoft Excel for further processing.

Figure 16 Overview of the full-report file comprising all selection/rating/classification details.

Finally, clicking the “Download BibTeX” button allows the user to download a BibTeX file containing all the literature attached to the project (Figure 17). Again, this export uses the LiSA-internal data structure from which the Bib-file is created.

Note: Just in case, the raw information with which LiSA was fed is stored in the LiSA database as well.

Figure 17 Plain-text example of an exported BibTeX library file.

Last edited Aug 18, 2015 at 3:12 PM by Naltoc, version 2