Skip to content

Commit

Permalink
Update the examples and example instructions (#63)
Browse files Browse the repository at this point in the history
  • Loading branch information
jteijema authored Sep 26, 2024
1 parent 910a423 commit a52d639
Show file tree
Hide file tree
Showing 19 changed files with 535 additions and 483 deletions.
10 changes: 7 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,20 @@
Examples are generated with the following code (from the root of the repo):

```
mkdir examples
mkdir examples/arfi_example
synergy_dataset get -d van_de_Schoot_2018 Smid_2020 -o examples/arfi_example/data -l
cd examples/arfi_example
asreview makita template arfi
asreview makita template arfi --platform linux
cd ../..
mkdir examples/basic_example
synergy_dataset get -d van_de_Schoot_2018 Smid_2020 -o examples/basic_example/data -l
cd examples/basic_example
asreview makita template basic
asreview makita template basic --platform linux
cd ../..
mkdir examples/multimodel_example
synergy_dataset get -d van_de_Schoot_2018 Smid_2020 -o examples/multimodel_example/data -l
cd examples/multimodel_example
asreview makita template multimodel
asreview makita template multimodel --platform linux
cd ../..
```
42 changes: 21 additions & 21 deletions examples/arfi_example/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Simulation study

*This project was rendered with ASReview-Makita version 0.0.0.*
*This project was rendered with ASReview-Makita version 0.9.2.*

This project was rendered from the Makita-ARFI template. See [asreview/asreview-makita#templates](https://github.com/asreview/asreview-makita#templates) for template rules and formats.

Expand All @@ -14,7 +14,7 @@ This project depends on Python 3.7 or later (python.org/download), and [ASReview
pip install asreview>=1.0 asreview-insights>=1.1.2 asreview-datatools
```

If wordcloud images are required, install the following dependencies.
For generating wordclouds, install the following dependencies.

```sh
pip install asreview-wordcloud
Expand All @@ -24,8 +24,8 @@ pip install asreview-wordcloud

The performance on the following datasets is evaluated:

- data/van_de_Schoot_2018.csv
- data/Smid_2020.csv
- data\Smid_2020.csv
- data\van_de_Schoot_2018.csv

## Run simulation

Expand All @@ -43,8 +43,8 @@ The following files are found in this project:
├── 📜README.md
├── 📜jobs.sh
├── 📂data
│ ├── 📜van_de_Schoot_2018.csv
│ ├── 📜Smid_2020.csv
│ ├── 📜van_de_Schoot_2018.csv
├── 📂scripts
│ ├── 📜get_plot.py
│ ├── 📜merge_descriptives.py
Expand All @@ -53,45 +53,45 @@ The following files are found in this project:
│ └── 📜...
└── 📂output
├── 📂simulation
| └── 📂van_de_Schoot_2018
| └── 📂Smid_2020
| ├── 📂descriptives
| | └── 📜data_stats_van_de_Schoot_2018.json
| | └── 📜data_stats_Smid_2020.json
| ├── 📂state_files
| | ├── 📜sim_van_de_Schoot_2018_`x`.asreview
| | ├── 📜sim_Smid_2020_`x`.asreview
| | └── 📜...
| └── 📂metrics
| ├── 📜metrics_sim_van_de_Schoot_2018_`x`.json
| ├── 📜metrics_sim_Smid_2020_`x`.json
| └── 📜...
| └── 📂Smid_2020
| └── 📂van_de_Schoot_2018
| ├── 📂descriptives
| | └── 📜data_stats_Smid_2020.json
| | └── 📜data_stats_van_de_Schoot_2018.json
| ├── 📂state_files
| | ├── 📜sim_Smid_2020_`x`.asreview
| | ├── 📜sim_van_de_Schoot_2018_`x`.asreview
| | └── 📜...
| └── 📂metrics
| ├── 📜metrics_sim_Smid_2020_`x`.json
| ├── 📜metrics_sim_van_de_Schoot_2018_`x`.json
| └── 📜...
├── 📂tables
| ├── 📜data_descriptives.csv
| ├── 📜data_descriptives.xlsx
| ├── 📜tds_sim_van_de_Schoot_2018.csv
| ├── 📜tds_sim_van_de_Schoot_2018.xlsx
| ├── 📜tds_sim_Smid_2020.csv
| ├── 📜tds_sim_Smid_2020.xlsx
| ├── 📜tds_sim_van_de_Schoot_2018.csv
| ├── 📜tds_sim_van_de_Schoot_2018.xlsx
| ├── 📜tds_summary.csv
| ├── 📜tds_summary.xlsx
| ├── 📜metrics_sim_van_de_Schoot_2018_metrics.csv
| ├── 📜metrics_sim_van_de_Schoot_2018_metrics.xlsx
| ├── 📜metrics_sim_Smid_2020_metrics.csv
| ├── 📜metrics_sim_Smid_2020_metrics.xlsx
| ├── 📜metrics_sim_van_de_Schoot_2018_metrics.csv
| ├── 📜metrics_sim_van_de_Schoot_2018_metrics.xlsx
| ├── 📜metrics_summary.csv
| └── 📜metrics_summary.xlsx
└── 📂figures
├── 📈plot_recall_van_de_Schoot_2018.png
├── 📈plot_recall_Smid_2020.png
├── 📈wordcloud_van_de_Schoot_2018.png
├── 📈wordcloud_relevant_van_de_Schoot_2018.png
└── 📈wordcloud_irrelevant_van_de_Schoot_2018.png
├── 📈plot_recall_van_de_Schoot_2018.png
├── 📈wordcloud_Smid_2020.png
├── 📈wordcloud_relevant_Smid_2020.png
└── 📈wordcloud_irrelevant_Smid_2020.png
├── 📈wordcloud_van_de_Schoot_2018.png
├── 📈wordcloud_relevant_van_de_Schoot_2018.png
└── 📈wordcloud_irrelevant_van_de_Schoot_2018.png
Loading

0 comments on commit a52d639

Please sign in to comment.