Nothing
#' @title Score the FACT-M
#'
#' @description
#' Generates all of the scores of the Functional Assessment of Cancer Therapy -
#' Melanoma (FACT-M, v4) from item responses.
#'
#' @details
#' Given a data frame that includes all of the FACT-M (Version 4) items as
#' variables, appropriately named, this function generates all of the FACT-M
#' scale scores. It is crucial that the item variables in the supplied data
#' frame are named according to FACT conventions. For example, the first
#' physical well-being item should be named GP1, the second GP2, and so on.
#' Please refer to the materials provided by \url{http://www.facit.org} for the
#' particular questionnaire you are using. In particular, refer to the left
#' margin of the official questionnaire (i.e., from facit.org) for the
#' appropriate item variable names.
#'
#' @section Note:
#' Keep in mind that this function (and R in general) is case-sensitive.
#'
#' All variables should be in numeric or integer format.
#'
#' This scoring function expects missing item responses to be coded as NA,
#' 8, or 9, and valid item responses to be coded as 0, 1, 2, 3, or 4. Any
#' other value for any of the items will result in an error message and no
#' scores.
#'
#' Some item variables are reverse coded for the purpose of generating the
#' scale scores. The official (e.g., from \url{http://www.facit.org}) SAS
#' and SPSS scoring algorithms for this questionnaire automatically replace
#' the original items with their reverse-coded versions. This can be
#' confusing if you accidentally run the algorithm more than once on your
#' data. As its default, \code{scoreFACT_M} DOES NOT replace any of your
#' original item variables with the reverse coded versions. However, for
#' consistentcy with the behavior of the other versions on
#' \url{http://www.facit.org}, the \code{updateItems} argument is
#' provided. If set to \code{TRUE}, any item that is supposed to be
#' reverse coded will be replaced with its reversed version in the data
#' frame returned by \code{scoreFACT_M}.
#'
#'
#' @param df A data frame with the FACT-M items, appropriately-named.
#' @param updateItems Logical, if \code{TRUE} any original item that is
#' reverse coded for scoring will be replaced by its reverse coded version
#' in the returned data frame, and any values of 8 or 9 will be replaced
#' with NA. The default, \code{FALSE}, returns the original items
#' unmodified.
#' @param keepNvalid Logical, if \code{TRUE} the function
#' returns an additional variable for most of the returned scale scores
#' containing the number of valid, non-missing responses from each
#' respondent to the items on the given scale. If \code{FALSE} (the
#' default), these variables are omitted from the returned data frame.
#'
#'
#' @return The original data frame is returned (optionally with modified
#' items if \code{updateItems = TRUE}) with new variables corresponding to
#' the scored scales. If \code{keepNvalid = TRUE}, for each scored scale an
#' additional variable is returned that contains the number of valid
#' responses each respondent made to the items making up the given scale.
#' These optional variables have names of the format \code{SCALENAME_N}.
#' The following scale scores are returned:
#'
#' \describe{
#' \item{PWB}{Physical Well-Being subscale}
#' \item{SWB}{Social/Family Well-Being subscale}
#' \item{EWB}{Emotional Well-Being subscale}
#' \item{FWB}{Physical Well-Being subscale}
#' \item{FACTG}{FACT-G Total Score (i.e., PWB+SWB+EWB+FWB)}
#' \item{MS}{Melanoma subscale}
#' \item{MSS}{Melanoma Surgery Scale}
#' \item{FACT_M_TOTAL}{FACT-M Total Score (i.e., PWB+SWB+EWB+FWB+MS+MSS)}
#' \item{FACT_M_TOI}{FACT-M Trial Outcome Index (e.g., PWB+FWB+MS+MSS)}
#' }
#'
#' @references FACT-M Scoring Guidelines, available at \url{http://www.facit.org}
#'
#' @export
#'
#' @examples
#' ## Setting up item names for fake data
#' G_names <- c(paste0('GP', 1:7),
#' paste0('GS', 1:7),
#' paste0('GE', 1:6),
#' paste0('GF', 1:7))
#' AC_names1 <- c('M1', 'M2', 'M3', 'B1', 'ITU4', 'An10', 'Hep3', 'C1', 'C6',
#' 'M5', 'M6', 'ITU3', 'MS8', 'M8', 'M9', 'HI7')
#' AC_names2 <- c('M10', 'M11', 'M12', 'M13', 'M14', 'M15', 'M16', 'M17')
#' AC_names <- c(AC_names1, AC_names2)
#' itemNames <- c(G_names, AC_names)
#' ## Generating random item responses for 8 fake respondents
#' set.seed(6375309)
#' exampleDat <- t(replicate(8, sample(0:4, size = length(itemNames), replace =
#' TRUE)))
#' ## Making half of respondents missing about 10% of items,
#' ## half missing about 50%.
#' miss10 <- t(replicate(4, sample(c(0, 9), prob = c(0.9, 0.1),
#' size = length(itemNames), replace = TRUE)))
#' miss50 <- t(replicate(4, sample(c(0, 9), prob = c(0.5, 0.5),
#' size = length(itemNames), replace = TRUE)))
#' missMtx <- rbind(miss10, miss50)
#' ## Using 9 as the code for missing responses
#' exampleDat[missMtx == 9] <- 9
#' exampleDat <- as.data.frame(cbind(ID = paste0('ID', 1:8),
#' as.data.frame(exampleDat)))
#' names(exampleDat) <- c('ID', itemNames)
#'
#' ## Returns data frame with scale scores and with original items untouched
#' scoredDat <- scoreFACT_M(exampleDat)
#' names(scoredDat)
#' scoredDat
#' ## Returns data frame with scale scores, with the appropriate items
#' ## reverse scored, and with item values of 8 and 9 replaced with NA.
#' ## Also illustrates the effect of setting keepNvalid = TRUE.
#' scoredDat <- scoreFACT_M(exampleDat, updateItems = TRUE, keepNvalid = TRUE)
#' names(scoredDat)
#' ## Descriptives of scored scales
#' summary(scoredDat[, c('PWB', 'SWB', 'EWB', 'FWB', 'FACTG',
#' 'MS', 'MSS', 'FACT_M_TOTAL', 'FACT_M_TOI')])
scoreFACT_M <- function(df, updateItems = FALSE, keepNvalid = FALSE) {
dfG <- scoreFACTG(df, updateItems = updateItems, keepNvalid = TRUE)
dfGup <- dfG
names(dfGup) <- toupper(names(dfGup))
G_names <- c(paste0("GP", 1:7), paste0("GS", 1:7), paste0("GE", 1:6),
paste0("GF", 1:7))
AC_names1 <- toupper(c("M1", "M2", "M3", "B1", "ITU4", "An10", "Hep3",
"C1", "C6", "M5", "M6", "ITU3", "MS8", "M8", "M9", "HI7"))
AC_names2 <- toupper(c("M10", "M11", "M12", "M13", "M14", "M15", "M16",
"M17"))
AC_names <- c(AC_names1, AC_names2)
revNames <- toupper(c("M1", "M2", "M3", "B1", "ITU4", "An10", "Hep3",
"C1", "M5", "M6", "ITU3", "MS8", "M8", "M9", "HI7", "M10", "M11",
"M12", "M13", "M14", "M15", "M16"))
AC_items <- dfGup[, AC_names]
if (any(!(as.matrix(AC_items) %in% c(0:4, 8, 9, NA)))) {
stop("At least 1 response is out of range (i.e., not 0-4, 8, 9, or NA)")
break
}
makeMiss <- function(x) {
x[x %in% c(8, 9)] <- NA
return(x)
}
AC_items <- as.data.frame(lapply(AC_items, makeMiss))
revHelper <- function(x) {
return(4 - x)
}
AC_items[, revNames] <- lapply(AC_items[, revNames], revHelper)
valid_N <- as.data.frame(lapply(AC_items, function(x) as.numeric(!is.na(x))))
AC_N1 <- rowSums(valid_N[, AC_names1])
AC_N2 <- rowSums(valid_N[, AC_names2])
TOTAL_N <- dfG$PWB_N + dfG$SWB_N + dfG$EWB_N + dfG$FWB_N + AC_N1
AC1 <- round(rowMeans(AC_items[, AC_names1], na.rm = TRUE) * length(AC_names1),
3)
AC1[AC_N1/length(AC_names1) <= 0.5] <- NA
AC2 <- round(rowMeans(AC_items[, AC_names2], na.rm = TRUE) * length(AC_names2),
3)
AC2[AC_N2/length(AC_names2) <= 0.5] <- NA
TOTAL <- dfG$PWB + dfG$SWB + dfG$EWB + dfG$FWB + AC1
TOTAL[TOTAL_N/length(c(G_names, AC_names1)) <= 0.8] <- NA
TOI <- dfG$PWB + dfG$FWB + AC1
FACT_M_TOTAL_N <- TOTAL_N
MS_N <- AC_N1
MSS_N <- AC_N2
MS <- AC1
MSS <- AC2
FACT_M_TOTAL <- TOTAL
FACT_M_TOI <- TOI
if (updateItems) {
dfItemPos <- unlist(sapply(AC_names, function(x) grep(x, names(dfG),
ignore.case = TRUE, value = FALSE)))
names(dfG)[dfItemPos] <- toupper(names(dfG)[dfItemPos])
dfG[, AC_names] <- AC_items
}
if (keepNvalid) {
dfOut <- as.data.frame(cbind(dfG, MS_N, MSS_N, FACT_M_TOTAL_N,
MS, MSS, FACT_M_TOTAL, FACT_M_TOI))
} else {
dfG[, "PWB_N"] <- NULL
dfG[, "SWB_N"] <- NULL
dfG[, "EWB_N"] <- NULL
dfG[, "FWB_N"] <- NULL
dfG[, "FACTG_N"] <- NULL
dfOut <- as.data.frame(cbind(dfG, MS, MSS, FACT_M_TOTAL, FACT_M_TOI))
}
return(dfOut)
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.