Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Guillem B M Hurault committed Oct 18, 2021
1 parent 7178bf0 commit e57f2e3
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Inter-rater reliability analysis of eczema segmentation from digital images

This repository contains the code developed for the paper by [**Hurault et al. (2021), "Detecting eczema areas in digital images: an impossible task?"**](#).
This repository contains the code developed for the paper by [**Hurault et al. (2021), "Detecting eczema areas in digital images: an impossible task?"**](#) (submitted to publication).

The code is written in the R language for statistical computing.

Expand All @@ -22,18 +22,15 @@ This project is organised as a research compendium, with a similar structure as

## Reproducibility

The data is not available due to our data sharing agreement.
This project is nonetheless organised to facilitate the reproducibility of the analysis.

This project is organised to facilitate the reproducibility of the analysis.
To reproduce the analysis, it is recommended to first open the project (`.Rproj` file) in [RStudio IDE](https://www.rstudio.com/products/rstudio/).

The project uses [renv](https://rstudio.github.io/renv/index.html) to manage package dependencies.
To install the packages and their dependencies required to reproduce analysis, first install renv with `install.packages("renv")`, and then call `renv::restore()`.

The analysis scripts are located in the [`analysis/`](analysis/) directory.
It is recommended to run the scripts in the order indicated by their prefix, although some scripts are independent from the others (e.g. [`01_analyse_quality.R`](analysis/01_analyse_quality.R) and [`03_estimate_performance.R`](analysis/03_estimate_performance.R)).

The data should be located in the `data/` directory.
The data should be located in the `data/` directory (it will be made available soon).
Intermediate and output files are saved to a `results/` directory.

## License
Expand Down

0 comments on commit e57f2e3

Please sign in to comment.