[Diagnosismed-commits] r13 - pkg/DiagnosisMed/man

[noreply at r-forge.r-project.org]

Author: pedrobrasil
Date: 2009-04-27 13:19:32 +0200 (Mon, 27 Apr 2009)
New Revision: 13

Modified:
   pkg/DiagnosisMed/man/interact.ROC.Rd
Log:


Modified: pkg/DiagnosisMed/man/interact.ROC.Rd
===================================================================
--- pkg/DiagnosisMed/man/interact.ROC.Rd	2009-04-21 14:43:17 UTC (rev 12)
+++ pkg/DiagnosisMed/man/interact.ROC.Rd	2009-04-27 11:19:32 UTC (rev 13)
@@ -9,10 +9,10 @@
 }
 \arguments{
   \item{gold}{A column in a data frame or a vector indicating the classification by the reference test. Must be coded either as 0 - without target condition - or 1 - with the target condition.}
-  \item{test}{A column in a data frame or a vector indicating the test under study (index test) results. Must be link[base]{numeric}.}
+  \item{test}{A column in a data frame or a vector indicating the test under study (index test) results. Must be \link[base]{numeric}.}
 }
 \details{
-interact.ROC is a call from roc.demo function in TeachingDemo package. The difference is that interact.ROC allow the input data be displayed as usually is in diagnostic studies, a column with the test result and the other with the reference standard results. Inside this function the "ask" option - which controls the "next" button to see the next graph - is turned off - par(ask=FALSE). Also other options must be set to this function to work fine. Type "options()". The option ask and device.ask.default should be set as FALSE, as they usually are by default. To turn it on again later, type par(ask=TRUE). The test must have a rationale that higher values of the index test belong to those with the target disease and those with lower values belong to those without the target disease. If this is not the case, the suggestion is to transform the tests results by multiplying it by -1 before running interact.ROC.
+interact.ROC is a call from roc.demo function in TeachingDemo package. The difference is that interact.ROC allow the input data be displayed as usually is in diagnostic studies, a column with the test result and the other with the reference standard results. Inside this function the "ask" option - which controls the "next" button to see the next graph - is turned off - par(ask=FALSE). Also, other options must be set to this function to work fine. Type "options()". The option ask and device.ask.default should be set as FALSE, as they usually are by default. To turn it on again later, type par(ask=TRUE). The test must have a rationale that higher values of the index test belong to those with the target disease and those with lower values belong to those without the target disease. If this is not the case, the suggestion is to transform the tests results by multiplying it by -1 before running interact.ROC.
 }
 \value{
 interact.ROC generates two graphs in the same window: the upper graph is a ROC graph (Sensitivity on the vertical axis and 1-Specificity on the horizontal axis); the lower graph is a density plot (the density on the vertical axis and the test cut-off (or threshold) on the horizontal axis). With a sliding button is possible to interact and see how  the Sensitivity and Specificity changes while changing the cut-off. In the upper graph