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

Citation for package and web app #72

Closed ejulia17 closed 4 years ago

ejulia17 commented 5 years ago

https://github.com/alan-turing-institute/DetectorChecker/issues/71

Further to the previous issue it would be good to provide citations as text and bibtext to encourage users to cite us. (It will be required for CRAN release anyway, so we may as well put that on the GitHub version.)

Below are suggestions, though I'd rely on you to fill in the right information where there are currently some ???.

Please include in README.md in DetectorChecker R package:

Brettschneider J, Giles O, Kendall W and Lazauskas T (2019) DetectorChecker: Assessment of damage to CT scanners. R Package, URL http:???

Brettschneider J, Giles O, Kendall W and Lazauskas T (2019) A Quick Guide for the EMCluster Package (Ver. 0.2-5). R Vignette, URL http:/???

Corresponding BibTeX entries:

@Misc{DetectorChecker2019, title = {{DetectorChecker}: Assessment of damage to CT scanners}, author = {Julia Brettschneider, Oscar Giles, Wilfrid Kendall and Tomas Lazauskas}, year = {2019}, note = {{R} Package, URL http://???}, } @Manual{DetectorChecker2019vignette, title = {}, author = {Julia Brettschneider, Oscar Giles, Wilfrid Kendall and Tomas Lazauskas}, year = {2019}, note = {{R} Vignette, URL http://???}, }

Please include in README.md in DetectorChecker web app:

Brettschneider J, Giles O, Kendall W and Lazauskas T (2019) DetectorChecker web app: Assessment of damage to CT scanners. R Package, URL http:???

Brettschneider J, Giles O, Kendall W and Lazauskas T (2019) DetectorChecker Instruction Manual, URL http:/???

Corresponding BibTeX entries:

@Misc{DetectorCheckerWebApp2019, title = {DetectorChecker web app}, author = {Julia Brettschneider, Oscar Giles, Wilfrid Kendall and Tomas Lazauskas}, year = {2019}, note = {Web App, URL http://???}, } @Manual{DetectorCheckerWebApp2019manual, title = {DetectorChecker Instruction Manual}, author = {Julia Brettschneider, Oscar Giles, Wilfrid Kendall and Tomas Lazauskas}, year = {2019}, note = {{R} Manual, URL http://???}, }

Does that sound okay to you?

OscartGiles commented 5 years ago

What's everyones thoughts on this? At the moment I have just added the first citation to the DetectorChecker repo. Do we want both? If so which would we like people to cite if they use the package?