View source: R/sx-scoreFACT_ES.R
scoreFACT_ES | R Documentation |
Generates all of the scores of the Functional Assessment of Cancer Therapy - Endocrine Symptom (FACT-ES, v4) from item responses.
scoreFACT_ES(df, updateItems = FALSE, keepNvalid = FALSE)
df |
A data frame with the FACT-ES items, appropriately-named. |
updateItems |
Logical, if |
keepNvalid |
Logical, if |
Given a data frame that includes all of the FACT-ES (Version 4) items as variables, appropriately named, this function generates all of the FACT-ES 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 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.
The original data frame is returned (optionally with modified
items if updateItems = TRUE
) with new variables corresponding to
the scored scales. If 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 SCALENAME_N
.
The following scale scores are returned:
Physical Well-Being subscale
Social/Family Well-Being subscale
Emotional Well-Being subscale
Physical Well-Being subscale
FACT-G Total Score (i.e., PWB+SWB+EWB+FWB)
18-Item Endocrine Symptom subscale
FACT-ES Total Score (i.e., PWB+SWB+EWB+FWB+ESS_18)
FACT-ES Trial Outcome Index (e.g., PWB+FWB+ESS_18)
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 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, scoreFACT_ES
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
http://www.facit.org, the updateItems
argument is
provided. If set to TRUE
, any item that is supposed to be
reverse coded will be replaced with its reversed version in the data
frame returned by scoreFACT_ES
.
FACT-ES Scoring Guidelines, available at http://www.facit.org
## 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_names <- c('ES1', 'ES2', 'ES3', 'ES4', 'ES5', 'ES6', 'ES7', 'ES8', 'ES9', 'ES10', 'An9', 'O2', 'C5', 'An10', 'Tax1', 'ES11', 'ES12', 'ES13') 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_ES(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_ES(exampleDat, updateItems = TRUE, keepNvalid = TRUE) names(scoredDat) ## Descriptives of scored scales summary(scoredDat[, c('PWB', 'SWB', 'EWB', 'FWB', 'FACTG', 'ESS_18', 'FACT_ES_TOTAL', 'FACT_ES_TOI')])
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.