-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.Rmd
154 lines (96 loc) · 6.45 KB
/
index.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
---
title: "Modeling ROC data"
author: "Dev P. Chakraborty, PhD"
date: "`r Sys.Date()`"
site: bookdown::bookdown_site
output: bookdown::html_document
documentclass: book
bibliography: [packages.bib, myRefs.bib]
biblio-style: apalike
link-citations: yes
github-repo: dpc10ster/RJafrocRocBook
description: "Understanding and modeling receiver operating characteristic (ROC) data."
---
```{r include=FALSE}
# automatically create a bib database for R packages
knitr::write_bib(c(
.packages(), 'bookdown', 'knitr', 'rmarkdown', 'ggplot2', 'mvtnorm',
'binom', 'exactci', 'RJafroc', 'bbmle', 'plotly'), 'packages.bib')
```
# Preface {-}
TBA
## Rationale and Organization
* Intended as an online update to my print book [@chakraborty2017observer].
* All references in this book to `RJafroc` refer to the R package with that name (case sensitive) [@R-RJafroc].
* Since its publication in 2017 `RJafroc`, on which the `R` code examples in the print book depend, has evolved considerably causing many of the examples to "break" if one uses the most current version of `RJafroc`. The code will still run if one uses [`RJafroc` 0.0.1](https://cran.r-project.org/src/contrib/Archive/RJafroc/) but this is inconvenient and misses out on many of the software improvements made since the print book appeared.
* This gives me the opportunity to update the print book.
* The online book has been divided into 3 books.
+ The [RJafrocQuickStartBook](https://dpc10ster.github.io/RJafrocQuickStart/) book.
+ **This book:** [RJafrocRocBook](https://dpc10ster.github.io/RJafrocRocBook/).
+ The [RJafrocFrocBook](https://dpc10ster.github.io/RJafrocFrocBook/) book.
## TBA Acknowledgements
Dr. Xuetong Zhai
Dr. Peter Phillips
Online Latex Editor [at this site](https://latexeditor.lagrida.com/)
Dataset contributors
## Temporary comments
This is intended to allow successful builds when a needed file is not in the build. These are indicated by, for example:
Chapter `TempComment \@ref(proper-roc-models)`
Fix these on final release.
* It is intended as an online update to my "physical" book [@chakraborty2017observer].
* Since its publication in 2017 the `RJafroc` package, on which the `R` code examples in the book depend, has evolved considerably, causing many of the examples to "break".
* This also gives me the opportunity to improve on the book and include additional material.
## TBA How much finished {-}
* HMF approximately 70%
* This book is currently (as of December 2021) in preparation.
* Parts labeled TBA and TODOLAST need to be updated on final revision.
## The pdf file of the book {-}
Support for the pdf file has been removed (4/8/23) as plots produced by `plotly` do not compile when using this format.
## The html version of the book {-}
Go [here](https://dpc10ster.github.io/RJafrocRocBook/) to view the `html` version of the book.
## A note on the online distribution mechanism of the book {-}
* In the hard-copy version of my book [@chakraborty2017observer] the online distribution mechanism was `BitBucket`.
* `BitBucket` allows code sharing within a _closed_ group of a few users (e.g., myself and a grad student).
* Since the purpose of open-source code is to encourage collaborations, this was, in hindsight, an unfortunate choice. Moreover, as my experience with R-packages grew, it became apparent that the vast majority of R-packages are shared on `GitHub`, not `BitBucket`.
* For these reasons I have switched to `GitHub`. All previous instructions pertaining to `BitBucket` are obsolete.
* In order to access `GitHub` material one needs to create a (free) `GitHub` account.
* Go to [this link](https://github.com) and click on `Sign Up`.
## Structure of the book {-}
The book is divided into parts as follows:
* Part I: Quick Start: intended for existing Windows `JAFROC` users who are seeking a quick-and-easy transition from Windows `JAFROC` to `RJafroc`.
* Part II: ROC paradigm: this covers the basics of the ROC paradigm
* Part III: Significance Testing: The general procedure used to determine the significance level, and associated statistics, of the observed difference in figure of merit between pairs of treatments or readers
* Part IV: FROC paradigm: TBA
## Contributing to this book {-}
I appreciate constructive feedback on this document. To do this raise an `Issue` on the `GitHub` [interface](https://github.com/dpc10ster/RJafrocRocBook). Click on the `Issues` tab under `dpc10ster/RJafrocRocBook`, then click on `New issue`. When done this way, contributions from users automatically become part of the `GitHub` documentation/history of the book.
## Is this book relevant to you and what are the alternatives? {-}
* Diagnostic imaging system evaluation
* Detection
* Detection combined with localization
* Detection combined with localization and classification
* Optimization of Artificial Intelligence (AI) algorithms
* CV
* Alternatives
## ToDos TBA {-}
* Check Bamber theorem derivation.
## Chapters needing heavy edits {-}
TBA
## Shelved vs. removed vs. parked folders needing heavy edits {-}
* replace functions with `\text{}`; eg. `\text{erf}` and `\text{exp}` in all of document
* Also for TPF, FPF etc.
* Temporarily shelved 17c-rsm-evidence.Rmd in removed folder
* Now 17-b is breaking; possibly related to changes in RJafroc: had to do with recent changes to RJafroc code - RSM_xFROC etc requiring intrinsic parameters; fixed 17-b
* parked has dependence of ROC/FROC performance on threshold
## Coding aids {-}
* sprintf("%.4f", proper formatting of numbers
* OpPtStr(, do:
* kbl(dfA, caption = "....", booktabs = TRUE, escape = FALSE) %>% collapse_rows(columns = c(1, 3), valign = "middle") %>% kable_styling(latex_options = c("basic", "scale_down", "HOLD_position"), row_label_position = "c")
* ```{r, attr.source = ".numberLines"}
* kbl(x12, caption = "Summary of optimization results using wAFROC-AUC.", booktabs = TRUE, escape = FALSE) %>% collapse_rows(columns = c(1), valign = "middle") %>% kable_styling(latex_options = c("basic", "scale_down", "HOLD_position"), row_label_position = "c")
* $\text{exp} \left ( -\lambda' \right )$ space before dollar sign generates a pdf error
* FP errors generated by GitHub actions due to undefined labels:
Error: Error: pandoc version 1.12.3 or higher is required and was not found (see the help page ?rmarkdown::pandoc_available).
In addition: Warning message:
In verify_rstudio_version() :
Please install or upgrade Pandoc to at least version 1.17.2; or if you are using RStudio, you can just install RStudio 1.0+.
Execution halted