Skip to content

Inter-rater reliability analysis of eczema segmentation in digital images

License

Notifications You must be signed in to change notification settings

ghurault/IRR-eczema-images

Repository files navigation

Inter-rater reliability analysis of eczema segmentation from digital images

This repository contains the code developed for the paper by Hurault et al. (2022), "Detecting eczema areas in digital images: an impossible task?" (in press at JID Innovations).

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

File structure

This project is organised as a research compendium, with a similar structure as R packages:

  • Functions/helpers are located in the R/ directory
  • Analysis scripts are located in the analysis/ directory
  • renv/ and renv.lock are files created by the renv package to manage package dependencies (see details below).

Analysis files

Reproducibility

This project is organised to facilitate the reproducibility of the analysis, using Docker and renv to reproduce the computational environment.

The Dockerfile contains the instructions to build a Docker image with RStudio, the correct versions of R installed and the packages needed to reproduce the analysis.

To reproduce the computational environment:

  1. Clone this repository
  2. In the console, navigate to the project directory.
  3. Build the Docker image with sudo docker build . -t ghurault/irr
  4. Run the Docker container with sudo docker run -d --rm -p 1212:8787 -e DISABLE_AUTH=true -v ${PWD}:/home/rstudio/IRR-eczema-images -v /home/rstudio/IRR-eczema-images/renv ghurault/irr. This command runs the Docker container in the background and mounts the current working directory (except the renv folder) inside the container.
  5. Access the Docker container http://localhost:1212/.
  6. Open the IRR-eczema-images directory and then click on IRR-eczema-images.Rproj to open the RStudio project.

If the project is not ran with Docker, 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/ 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 and 03_estimate_performance.R).

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

This open source version of this project is licensed under the GPLv3 license, which can be seen in the LICENSE file.