-
Notifications
You must be signed in to change notification settings - Fork 112
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
Add documentation for SLR #333
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Conducting automated cross-library search | ||
|
||
## Providing a study file for automated search | ||
|
||
To provide automated search JabRef needs the set of targeted digital libraries and the used queries. | ||
To provide these a `study.bib` file, also called study definition, has to be created. | ||
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. How this file is created? 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. Hey there! |
||
This file contains different entries with different information. | ||
This file have to be provided within an otherwise empty fully setup git repository. | ||
|
||
Example study definition file | ||
|
||
```bibtex | ||
% Encoding: UTF-8 | ||
|
||
@Study{v10, | ||
author = {Jab Ref}, | ||
lastsearchdate = {2020-11-18}, | ||
name = {TestStudyName}, | ||
researchquestions = {Question1; Question2; Question3}, | ||
} | ||
|
||
@SearchQuery{query1, | ||
query={Quantum}, | ||
} | ||
|
||
@SearchQuery{query2, | ||
query={title:"Cloud Computing"}, | ||
} | ||
|
||
@Library{library1, | ||
name = {Springer}, | ||
enabled = {true}, | ||
comment = {}, | ||
} | ||
|
||
@Library{library2, | ||
name = {IEEEXplore}, | ||
enabled = {false}, | ||
comment = {}, | ||
} | ||
``` | ||
|
||
## Executing the automated search | ||
|
||
To execute the automated search navigate in the toolbar to **Tools\|Start systematic literature review** and click it. | ||
|
||
![Start an automated search](../../.gitbook/assets/start-SLR.png) | ||
|
||
Then select the `study.bib` file in the file explorer dialogue that is located in the git repository. | ||
|
||
![Select the study definition file](../../.gitbook/assets/select-study-definition.png) | ||
|
||
After that the automated search is executed and any new studies are commited and pushed to the configured git repository. | ||
The local repository now contains the retrieved studies sorted by the respective query and digital library that retrieved it. | ||
|
||
![Repository structure](../../.gitbook/assets/repository-structure.png) | ||
|
||
The `result.bib` located in the query folder contains the merged results from all fetcher for the respective query. | ||
The `studyResult.bib` contains the merged results for all queries. |
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.
It would be cool if you could describe the feature in one or two sentences.
e.g. JabRef has the possibilty to do automatic cross library searches for systematic literature review...