-
Notifications
You must be signed in to change notification settings - Fork 131
Add user documentation for SLR tool #616
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
mannatjain11465-netizen
wants to merge
18
commits into
JabRef:main
from
mannatjain11465-netizen:slr-doc
Closed
Changes from 11 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
2673fe7
Add user documentation for SLR tool
mannatjain11465-netizen 7d050b5
Fix markdownlint issues in SLR documentation
mannatjain11465-netizen 0e069a4
Fix markdownlint errors in AI documentation
mannatjain11465-netizen 74f1067
Fix markdownlint list spacing and cleanup
mannatjain11465-netizen 94f4654
Refine SLR documentation
mannatjain11465-netizen f3fb79e
Refine SLR documentation
mannatjain11465-netizen ebf7e02
Fix markdownlint issues
mannatjain11465-netizen 310bd20
Remove unrelated AI doc change from SLR PR
mannatjain11465-netizen ef0f435
Refine SLR documentation
mannatjain11465-netizen 61283f0
Fix markdownlint issues
mannatjain11465-netizen bb63b3b
Merge branch 'main' into slr-doc
koppor dd805cd
Add slr-example.png
mannatjain11465-netizen 27b2d8f
Add SLR example
mannatjain11465-netizen eb6c289
Resolved markdownlint errors
mannatjain11465-netizen 878cc08
Fix markdownlint errors
mannatjain11465-netizen afb1c76
Add example in the SLR doc
mannatjain11465-netizen 3bc736a
Fix markdownlint issues
mannatjain11465-netizen cbfd3ca
Fix markdownlint issues
mannatjain11465-netizen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| # Systematic literature review | ||
|
|
||
| JabRef supports managing systematic literature reviews by structuring research questions, search queries, catalogs, and results within a dedicated study directory created by JabRef. | ||
| This feature helps organize search configuration and collected references, but it does not replace methodological decisions made by the researcher. | ||
|
|
||
| --- | ||
|
|
||
| ## Starting a systematic literature review | ||
|
|
||
| A new study definition can be created via: | ||
|
|
||
| `Tools → Start new systematic literature review` | ||
|
|
||
| <figure> | ||
| <img src="../.gitbook/assets/slr_start-menu.png" alt="Start new systematic literature review dialog"> | ||
| <figcaption>Starting a new systematic literature review</figcaption> | ||
| </figure> | ||
|
|
||
| This opens the **Define study parameters** dialog, where JabRef stores the configuration used for search and data collection. | ||
|
|
||
| --- | ||
|
|
||
| ## Study parameters | ||
|
|
||
| The study definition dialog contains several sections that determine how JabRef performs searches and stores results. | ||
|
|
||
| <figure> | ||
| <img src="../.gitbook/assets/slr-define-parameters.png" alt="Define study parameters window"> | ||
| <figcaption>Study definition dialog</figcaption> | ||
| </figure> | ||
|
|
||
| ### Authors and title | ||
|
|
||
| This section defines the study metadata: | ||
|
|
||
| * Study title | ||
| * At least one author | ||
|
|
||
| These elements identify the study and are required before the survey can begin. | ||
|
|
||
| --- | ||
|
|
||
| ### Research questions | ||
|
|
||
| Research questions define the scope of the study within JabRef. | ||
| They help relate queries and later screening decisions to the study purpose. | ||
|
|
||
| Each question should be: | ||
|
|
||
| * Clear | ||
| * Focused | ||
| * Defined by the research goal rather than tool settings | ||
|
|
||
| <figure> | ||
| <img src="../.gitbook/assets/slr-questions.png" alt="Research questions tab"> | ||
| <figcaption>Defining research questions</figcaption> | ||
| </figure> | ||
|
|
||
| --- | ||
|
|
||
| ### Queries | ||
|
|
||
| Queries define how JabRef retrieves literature from the selected catalogs. | ||
|
|
||
| <figure> | ||
| <img src="../.gitbook/assets/slr-queries.png" alt="Queries tab of SLR setup"> | ||
| <figcaption>Defining search queries</figcaption> | ||
| </figure> | ||
|
|
||
| Queries typically combine keywords using Boolean operators: | ||
|
|
||
| * `AND` | ||
| * `OR` | ||
| * `NOT` | ||
|
|
||
| Queries can be adjusted later if search results need refinement. | ||
|
|
||
| --- | ||
|
|
||
| ### Catalogs | ||
|
|
||
| Catalogs define the external services that JabRef queries for literature. | ||
|
|
||
| <figure> | ||
| <img src="../.gitbook/assets/slr-catalogs.png" alt="Catalog selection in SLR"> | ||
| <figcaption>Selecting catalogs</figcaption> | ||
| </figure> | ||
|
|
||
| Examples include: | ||
|
|
||
| * ACM Portal | ||
| * arXiv | ||
| * DBLP | ||
| * Crossref | ||
| * IEEE Xplore | ||
|
|
||
| Using multiple catalogs increases coverage and reduces the risk of selection bias. | ||
|
|
||
| --- | ||
|
|
||
| ### Finalize | ||
|
|
||
| In this step, a directory for storing the study is selected. | ||
|
|
||
| ⚠ **The selected study directory must be empty before starting the survey.** | ||
| When the survey begins, JabRef initializes the directory by creating the internal study structure, configuration files, and result database. | ||
|
|
||
| The **Start survey** button becomes available only after the study definition is complete. The definition must include: | ||
|
|
||
| * Study title | ||
|
||
| * At least one author | ||
| * At least one research question | ||
| * At least one query | ||
|
|
||
| These requirements ensure that JabRef can execute searches and store results using the defined study structure. | ||
|
|
||
| --- | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Clear sign of AI geneation. |
||
|
|
||
| ## After starting the survey | ||
|
|
||
| Starting the survey triggers the search and data collection process using the defined study parameters. | ||
|
|
||
| During this process: | ||
|
|
||
| * Queries are executed on the selected catalogs | ||
| * Retrieved records are written into the study database | ||
| * The study directory structure is populated with configuration and result data | ||
|
|
||
| References can then be: | ||
|
|
||
| * Screened | ||
| * Filtered | ||
| * Tagged | ||
| * Exported | ||
|
|
||
| <figure> | ||
| <img src="../.gitbook/assets/slr-study-folder.png" alt="SLR study folder structure"> | ||
| <figcaption>Generated study directory structure after starting the survey</figcaption> | ||
| </figure> | ||
|
|
||
| --- | ||
|
|
||
| ## Role of the SLR feature | ||
|
|
||
| The SLR feature provides structural and organizational support inside JabRef. It does **not**: | ||
|
|
||
| * Perform methodological quality assessment | ||
| * Replace screening decisions | ||
| * Replace inclusion or exclusion criteria | ||
| * Define research methodology | ||
|
|
||
| It supports managing search processes and organizing review data within JabRef. | ||
|
|
||
| --- | ||
|
|
||
| ## Best practices | ||
|
|
||
| * Define research questions before constructing queries | ||
| * Start with broader queries and refine if needed | ||
| * Use multiple catalogs to retrieve records from different sources | ||
| * Document queries used in the study definition | ||
| * Use tags and groups to organize screening decisions | ||
|
|
||
| This supports consistent and reproducible handling of search results in JabRef. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Example still missing