search

alan-turing-institute / DetectorChecker

Project to develop software to assess developing detector screen damage (Web App based on the original DetectorChecker package)
https://detectorchecker.azurewebsites.net
MIT License
0 stars 1 forks source link

Iss35 #39

Closed OscartGiles closed 5 years ago

OscartGiles commented 5 years ago

Add documentation to repo. Issue: https://github.com/alan-turing-institute/DetectorChecker/issues/35

I have added the documentation and example datasets to the repo and placed the whole package in the top level directory (rather than in a folder called "package". Does this layout work for you @ejulia17 and @WilfridSKendall ?

Changes

  1. Added example datasets in examples folder
  2. Place all the package in the top directory.

Tests

All passing

WilfridSKendall commented 5 years ago

I'll look as soon as I can, but busy all afternoon with students :-(

ejulia17 commented 5 years ago

Dear Oscar,

apologies about the delay; I was busy with the R-code and didn't notice your email in this account.

I am a little unsure what this is about - maybe I can not yet see everything in the way you think I would. Do I understand correctly that this is mainly about directory structure (what you call "layout")?

Do I assume correctly that this the R-package, not the web app?

If yes, I am not sure why the file BIN +307 KB Documentation/Manual.pdf is with the list of files of the package. This file is handwritten documentation we put together to explain the how the web app works. It is very superficial and refers to the web app only. It does not replace documentation for an R package as known to R users. I was actually about to post a separate issue about that documentation for the R package, so that will come separately in a bit...

Best wishes, Julia