Improve documentation with more references

This commit is contained in:
Joel Therrien 2019-07-22 11:41:25 -07:00
parent c36a3d8d37
commit cb4c9b73ae
4 changed files with 32 additions and 13 deletions

View file

@ -16,6 +16,11 @@
#' list should correspond to one of the events in the order of event 1 to J,
#' and should be a vector of the same length as responses.
#' @export
#' @references Section 3.2 of Wolbers, Marcel, Paul Blanche, Michael T. Koller,
#' Jacqueline C M Witteman, and Thomas A Gerds. 2014. “Concordance for
#' Prognostic Models with Competing Risks.” Biostatistics 15 (3): 52639.
#' https://doi.org/10.1093/biostatistics/kxt059.
#'
#' @examples
#' data <- data.frame(delta=c(1,1,0,0,2,2), T=1:6, x=1:6)
#'

View file

@ -15,9 +15,13 @@
#' @source The data was obtained from the randomForestSRC R package.
#'
#' @references Bacon MC, von Wyl V, Alden C, Sharp G, Robison E, Hessol N, Gange
#' S, Barranday Y, Holman S, Weber K, Young MA (2005). “The Womens
#' Interagency HIV Study: an Observational Cohort Brings Clinical Sciences to
#' the Bench.” Clinical and Vaccine Immunology, 12(9), 10131019.
#' S, Barranday Y, Holman S, Weber K, Young MA (2005). “The Womens Interagency
#' HIV Study: an Observational Cohort Brings Clinical Sciences to the Bench.”
#' Clinical and Vaccine Immunology, 12(9), 10131019.
#' doi:10.1128/CDLI.12.9.1013-1019.2005.
#'
#' Ishwaran, H., and Udaya B. Kogalur. 2018. Random Forests for Survival,
#' Regression, and Classification (Rf-Src). manual.
#' https://cran.r-project.org/package=randomForestSRC.
#'
"wihs"

View file

@ -41,3 +41,9 @@ mortalities <- list(
naiveConcordance(CR_Response(newData$delta, newData$T), mortalities)
}
\references{
Section 3.2 of Wolbers, Marcel, Paul Blanche, Michael T. Koller,
Jacqueline C M Witteman, and Thomas A Gerds. 2014. “Concordance for
Prognostic Models with Competing Risks.” Biostatistics 15 (3): 52639.
https://doi.org/10.1093/biostatistics/kxt059.
}

View file

@ -25,9 +25,13 @@ time may also be censored.
}
\references{
Bacon MC, von Wyl V, Alden C, Sharp G, Robison E, Hessol N, Gange
S, Barranday Y, Holman S, Weber K, Young MA (2005). “The Womens
Interagency HIV Study: an Observational Cohort Brings Clinical Sciences to
the Bench.” Clinical and Vaccine Immunology, 12(9), 10131019.
doi:10.1128/CDLI.12.9.1013-1019.2005.
S, Barranday Y, Holman S, Weber K, Young MA (2005). “The Womens Interagency
HIV Study: an Observational Cohort Brings Clinical Sciences to the Bench.”
Clinical and Vaccine Immunology, 12(9), 10131019.
doi:10.1128/CDLI.12.9.1013-1019.2005.
Ishwaran, H., and Udaya B. Kogalur. 2018. Random Forests for Survival,
Regression, and Classification (Rf-Src). manual.
https://cran.r-project.org/package=randomForestSRC.
}
\keyword{datasets}