Skip to content
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 examples of advanced SYNERGY use #96

Merged
merged 40 commits into from
Apr 24, 2023
Merged
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
0a89e4a
Add new README to branch
J535D165 Mar 22, 2023
0b25352
Update README.md
J535D165 Mar 22, 2023
41dfbd8
Add files via upload
J535D165 Mar 22, 2023
f81c8fa
Add image
J535D165 Mar 22, 2023
9ff3262
Update README.md
J535D165 Mar 22, 2023
92e25d3
Add Kwok dataset
J535D165 Mar 22, 2023
bdd4ac8
Update README.md
J535D165 Mar 22, 2023
8033a6c
Update README.md
J535D165 Mar 22, 2023
a6a146e
Update README.md
J535D165 Mar 22, 2023
7f45467
Update README.md
J535D165 Mar 22, 2023
abb1eb0
Update README.md
J535D165 Mar 22, 2023
b4046a4
Add link to web.archive.org
J535D165 Apr 1, 2023
9bd3dc9
Create ATTRIBUTION.md
J535D165 Apr 2, 2023
e44ac02
Update README.md
J535D165 Apr 2, 2023
c60ea72
Update ATTRIBUTION.md
J535D165 Apr 2, 2023
ef31c70
Update LICENSE
J535D165 Apr 2, 2023
7ee4b0c
Update broken links in ATTRIBUTION.md
J535D165 Apr 4, 2023
7d48dfc
Merge branch 'master' into README
J535D165 Apr 4, 2023
ca0a175
Update numbers in README.md
J535D165 Apr 10, 2023
6694da4
Fix wrong percentage
J535D165 Apr 10, 2023
4342069
Add examples on Python package
J535D165 Apr 15, 2023
51dd9d8
Update README.md
J535D165 Apr 15, 2023
d8de592
Update README.md
J535D165 Apr 15, 2023
b37200f
Update attribution
J535D165 Apr 15, 2023
412eba5
Update ATTRIBUTION.md
J535D165 Apr 15, 2023
5ba3470
Update ATTRIBUTION.md
J535D165 Apr 15, 2023
b8ec22d
Update README.md
J535D165 Apr 15, 2023
dd95287
Update README.md
J535D165 Apr 15, 2023
f42e058
Add LICENSE info
J535D165 Apr 16, 2023
bce3a20
Update license text
J535D165 Apr 16, 2023
10fe4a0
Update codebook
J535D165 Apr 16, 2023
202c2ee
Merge branch 'README' into examples
J535D165 Apr 16, 2023
b7eaad3
Merge branch 'master' into README
J535D165 Apr 16, 2023
ad598cc
Merge branch 'README' into examples
J535D165 Apr 16, 2023
cab2654
Add notebook on concepts in SYNERGY
J535D165 Apr 17, 2023
da3c1d4
Add more API examples
J535D165 Apr 24, 2023
5519fe1
Remove changes to readme
J535D165 Apr 24, 2023
4bc5697
Delete ATTRIBUTION.md
J535D165 Apr 24, 2023
dd337f8
Add Attribution
J535D165 Apr 24, 2023
9cd3fb6
Merge branch 'master' into examples
J535D165 Apr 24, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update README.md
  • Loading branch information
J535D165 authored Mar 22, 2023
commit 0b2535205f816da0ef367800366bea6470cafa7e
46 changes: 21 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@
This is work in progress, please do NOT use. Public release under open license will follow soon. Questions? Contact [email protected].

# :exclamation: This is work in progress, please do NOT use. Public release under open license will follow soon. Questions? Contact [email protected].

# Release branch for ODSS dataset

# SYNERGY dataset

ODSS is a dataset to facilitate the development of machine learning algorithms for the systematic review study selection process. Systematic reviews are an essential part of evidence-based medicine and involve the synthesis of all available evidence on a particular research question. However, the process of selecting relevant studies for inclusion in a systematic review can be time-consuming and challenging, particularly as the number of available studies increases. This dataset aims to improve the efficiency and accuracy of study selection by providing a collection of pre-processed research articles that can be used to train and test machine learning algorithms.

## Get the data

The easiest way to get the SYNERGY dataset is via the `synergy-dataset` Python package.

```bash
pip install synergy-dataset
```

```python
synergy get <FOLDER_TO_DOWNLOAD>
```

with `synergy list` you can get an overview of the datasets and their properties.

> Slow internet connection or limited resources?
> The SYNERGY dataset is a large dataset with 50787117 datapoints. The total file size is 600Mb. It is possible to download a version of the dataset with only titles, abstracts, and labels. This dataset is smaller in size and can be rich enough for several applications. Download the dataset with `synergy get --light`


## Datasets

| Nr | Dataset | Field | Records | Included | % |
Expand Down Expand Up @@ -36,29 +55,6 @@ ODSS is a dataset to facilitate the development of machine learning algorithms f

Total records = 108853, total inclusions 1588 (1.46%)

## Get the data

The easiest way to get the ODSS dataset is via the PyODSS Python package.

### Installation

Install PyODSS via PyPI.

```bash
pip install pyodss
```

### Download data

```python
pyodss get <FOLDER_TO_DOWNLOAD>
```

with `pyodss list` you can get an overview of the datasets and their properties.

> Slow internet connection or limited resources?
> The ODSS dataset is a large dataset with xxxxx datapoints. The total file size is yyyMb. It is possible to download a version of the dataset with only titles, abstracts, and labels. This dataset is smaller in size and can be rich enough for some applications. Download the dataset with `pyodss get --light`

### Integration with ASReview Makita

First install both pyodss and makita with
Expand Down