scoreFACIT_AD: Score the FACIT-AD
In FACTscorer: Scores the FACT and FACIT Family of Patient-Reported Outcome Measures
Description
Usage
Arguments
Details
Value
Note
References
Examples
View source: R/sx-scoreFACIT_AD.R
Description
Generates all of the scores of the Functional Assessment of Chronic Illness Therapy -
Abdominal Discomfort (FACIT-AD, v4) from item responses.
Usage
1
scoreFACIT_AD(df, updateItems = FALSE, keepNvalid = FALSE)
Arguments
df
A data frame with the FACIT-AD items, appropriately-named.
updateItems
Logical, if 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, FALSE, returns the original items
unmodified.
keepNvalid
Logical, if TRUE the function
returns an additional variable for each of the returned scale scores
containing the number of valid, non-missing responses from each
respondent to the items on the given scale. If FALSE (the
default), these variables are omitted from the returned data frame.
Details
Given a data frame that includes all of the FACIT-AD (Version 4) items as
variables, appropriately named, this function generates all of the FACIT-AD
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.
Value
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:
- PWB
Physical Well-Being subscale
- SWB
Social/Family Well-Being subscale
- EWB
Emotional Well-Being subscale
- FWB
Physical Well-Being subscale
- FACTG
FACT-G Total Score (i.e., PWB+SWB+EWB+FWB)
- ADS
Abdominal Discomfort subscale
- FACIT_AD_TOTAL
FACIT-AD Total Score (i.e., PWB+SWB+EWB+FWB+ADS)
- FACIT_AD_TOI
FACIT-AD Trial Outcome Index (e.g., PWB+FWB+ADS)
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 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, scoreFACIT_AD 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 scoreFACIT_AD.
References
FACIT-AD Scoring Guidelines, available at http://www.facit.org
Examples
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
## 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('O3', 'ACT11', 'AD1')
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 <- scoreFACIT_AD(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 <- scoreFACIT_AD(exampleDat, updateItems = TRUE, keepNvalid = TRUE)
names(scoredDat)
## Descriptives of scored scales
summary(scoredDat[, c('PWB', 'SWB', 'EWB', 'FWB', 'FACTG',
'ADS', 'FACIT_AD_TOTAL', 'FACIT_AD_TOI')])
Example output
[1] "ID" "GP1" "GP2" "GP3"
[5] "GP4" "GP5" "GP6" "GP7"
[9] "GS1" "GS2" "GS3" "GS4"
[13] "GS5" "GS6" "GS7" "GE1"
[17] "GE2" "GE3" "GE4" "GE5"
[21] "GE6" "GF1" "GF2" "GF3"
[25] "GF4" "GF5" "GF6" "GF7"
[29] "O3" "ACT11" "AD1" "PWB"
[33] "SWB" "EWB" "FWB" "FACTG"
[37] "ADS" "FACIT_AD_TOTAL" "FACIT_AD_TOI"
ID GP1 GP2 GP3 GP4 GP5 GP6 GP7 GS1 GS2 GS3 GS4 GS5 GS6 GS7 GE1 GE2 GE3 GE4
1 ID1 3 3 1 2 2 3 9 9 2 1 1 1 0 2 0 9 0 2
2 ID2 9 3 0 4 4 4 3 9 4 3 2 9 2 2 3 1 2 1
3 ID3 2 3 3 4 4 0 0 3 3 9 2 9 3 2 3 9 0 2
4 ID4 2 1 0 4 9 3 0 2 1 1 2 3 4 4 9 1 1 2
5 ID5 9 4 9 9 0 2 9 9 2 9 3 2 4 9 1 9 4 3
6 ID6 9 1 2 3 2 3 2 9 0 9 9 2 9 0 0 9 9 9
7 ID7 1 4 3 9 2 9 0 9 0 9 9 9 9 2 9 1 9 9
8 ID8 3 1 9 9 0 9 2 9 4 2 9 9 9 9 2 9 9 9
GE5 GE6 GF1 GF2 GF3 GF4 GF5 GF6 GF7 O3 ACT11 AD1 PWB SWB EWB FWB
1 4 3 0 3 2 9 1 2 2 4 2 9 11.667 8.167 13.2 11.667
2 1 0 3 4 0 9 3 3 9 2 0 2 7.000 18.200 14.0 18.200
3 4 0 2 2 2 1 0 0 3 3 2 2 12.000 18.200 13.2 10.000
4 0 4 0 3 2 3 2 4 3 3 1 1 16.333 17.000 12.0 17.000
5 4 2 9 1 9 9 9 9 0 0 1 9 NA 19.250 7.2 NA
6 1 9 3 9 0 9 9 9 1 9 9 9 12.833 NA NA NA
7 2 9 3 9 9 9 0 3 9 1 1 0 14.000 NA NA NA
8 9 9 9 2 2 9 9 9 9 2 2 9 17.500 NA NA NA
FACTG ADS FACIT_AD_TOTAL FACIT_AD_TOI
1 44.701 3.0 47.701 26.334
2 57.400 8.0 65.400 33.200
3 53.400 5.0 58.400 27.000
4 62.333 7.0 69.333 40.333
5 NA 10.5 NA NA
6 NA NA NA NA
7 NA 10.0 NA NA
8 NA 6.0 NA NA
[1] "ID" "GP1" "GP2" "GP3"
[5] "GP4" "GP5" "GP6" "GP7"
[9] "GS1" "GS2" "GS3" "GS4"
[13] "GS5" "GS6" "GS7" "GE1"
[17] "GE2" "GE3" "GE4" "GE5"
[21] "GE6" "GF1" "GF2" "GF3"
[25] "GF4" "GF5" "GF6" "GF7"
[29] "O3" "ACT11" "AD1" "PWB_N"
[33] "SWB_N" "EWB_N" "FWB_N" "FACTG_N"
[37] "PWB" "SWB" "EWB" "FWB"
[41] "FACTG" "ADS_N" "FACIT_AD_TOTAL_N" "ADS"
[45] "FACIT_AD_TOTAL" "FACIT_AD_TOI"
PWB SWB EWB FWB
Min. : 7.00 Min. : 8.167 Min. : 7.20 Min. :10.00
1st Qu.:11.83 1st Qu.:17.000 1st Qu.:12.00 1st Qu.:11.25
Median :12.83 Median :18.200 Median :13.20 Median :14.33
Mean :13.05 Mean :16.163 Mean :11.92 Mean :14.22
3rd Qu.:15.17 3rd Qu.:18.200 3rd Qu.:13.20 3rd Qu.:17.30
Max. :17.50 Max. :19.250 Max. :14.00 Max. :18.20
NA's :1 NA's :3 NA's :3 NA's :4
FACTG ADS FACIT_AD_TOTAL FACIT_AD_TOI
Min. :44.70 Min. : 3.000 Min. :47.70 Min. :26.33
1st Qu.:51.23 1st Qu.: 5.500 1st Qu.:55.73 1st Qu.:26.83
Median :55.40 Median : 7.000 Median :61.90 Median :30.10
Mean :54.46 Mean : 7.071 Mean :60.21 Mean :31.72
3rd Qu.:58.63 3rd Qu.: 9.000 3rd Qu.:66.38 3rd Qu.:34.98
Max. :62.33 Max. :10.500 Max. :69.33 Max. :40.33
NA's :4 NA's :1 NA's :4 NA's :4
FACTscorer documentation built on May 29, 2017, 3:45 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Details Value Note References Examples
View source: R/sx-scoreFACIT_AD.R
Description
Generates all of the scores of the Functional Assessment of Chronic Illness Therapy - Abdominal Discomfort (FACIT-AD, v4) from item responses.
Usage
1 | scoreFACIT_AD(df, updateItems = FALSE, keepNvalid = FALSE)
|
Arguments
df |
A data frame with the FACIT-AD items, appropriately-named. |
updateItems |
Logical, if |
keepNvalid |
Logical, if |
Details
Given a data frame that includes all of the FACIT-AD (Version 4) items as variables, appropriately named, this function generates all of the FACIT-AD 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.
Value
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:
- PWB
Physical Well-Being subscale
- SWB
Social/Family Well-Being subscale
- EWB
Emotional Well-Being subscale
- FWB
Physical Well-Being subscale
- FACTG
FACT-G Total Score (i.e., PWB+SWB+EWB+FWB)
- ADS
Abdominal Discomfort subscale
- FACIT_AD_TOTAL
FACIT-AD Total Score (i.e., PWB+SWB+EWB+FWB+ADS)
- FACIT_AD_TOI
FACIT-AD Trial Outcome Index (e.g., PWB+FWB+ADS)
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 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, scoreFACIT_AD 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 scoreFACIT_AD.
References
FACIT-AD Scoring Guidelines, available at http://www.facit.org
Examples
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 | ## 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('O3', 'ACT11', 'AD1')
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 <- scoreFACIT_AD(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 <- scoreFACIT_AD(exampleDat, updateItems = TRUE, keepNvalid = TRUE)
names(scoredDat)
## Descriptives of scored scales
summary(scoredDat[, c('PWB', 'SWB', 'EWB', 'FWB', 'FACTG',
'ADS', 'FACIT_AD_TOTAL', 'FACIT_AD_TOI')])
|
Example output
[1] "ID" "GP1" "GP2" "GP3"
[5] "GP4" "GP5" "GP6" "GP7"
[9] "GS1" "GS2" "GS3" "GS4"
[13] "GS5" "GS6" "GS7" "GE1"
[17] "GE2" "GE3" "GE4" "GE5"
[21] "GE6" "GF1" "GF2" "GF3"
[25] "GF4" "GF5" "GF6" "GF7"
[29] "O3" "ACT11" "AD1" "PWB"
[33] "SWB" "EWB" "FWB" "FACTG"
[37] "ADS" "FACIT_AD_TOTAL" "FACIT_AD_TOI"
ID GP1 GP2 GP3 GP4 GP5 GP6 GP7 GS1 GS2 GS3 GS4 GS5 GS6 GS7 GE1 GE2 GE3 GE4
1 ID1 3 3 1 2 2 3 9 9 2 1 1 1 0 2 0 9 0 2
2 ID2 9 3 0 4 4 4 3 9 4 3 2 9 2 2 3 1 2 1
3 ID3 2 3 3 4 4 0 0 3 3 9 2 9 3 2 3 9 0 2
4 ID4 2 1 0 4 9 3 0 2 1 1 2 3 4 4 9 1 1 2
5 ID5 9 4 9 9 0 2 9 9 2 9 3 2 4 9 1 9 4 3
6 ID6 9 1 2 3 2 3 2 9 0 9 9 2 9 0 0 9 9 9
7 ID7 1 4 3 9 2 9 0 9 0 9 9 9 9 2 9 1 9 9
8 ID8 3 1 9 9 0 9 2 9 4 2 9 9 9 9 2 9 9 9
GE5 GE6 GF1 GF2 GF3 GF4 GF5 GF6 GF7 O3 ACT11 AD1 PWB SWB EWB FWB
1 4 3 0 3 2 9 1 2 2 4 2 9 11.667 8.167 13.2 11.667
2 1 0 3 4 0 9 3 3 9 2 0 2 7.000 18.200 14.0 18.200
3 4 0 2 2 2 1 0 0 3 3 2 2 12.000 18.200 13.2 10.000
4 0 4 0 3 2 3 2 4 3 3 1 1 16.333 17.000 12.0 17.000
5 4 2 9 1 9 9 9 9 0 0 1 9 NA 19.250 7.2 NA
6 1 9 3 9 0 9 9 9 1 9 9 9 12.833 NA NA NA
7 2 9 3 9 9 9 0 3 9 1 1 0 14.000 NA NA NA
8 9 9 9 2 2 9 9 9 9 2 2 9 17.500 NA NA NA
FACTG ADS FACIT_AD_TOTAL FACIT_AD_TOI
1 44.701 3.0 47.701 26.334
2 57.400 8.0 65.400 33.200
3 53.400 5.0 58.400 27.000
4 62.333 7.0 69.333 40.333
5 NA 10.5 NA NA
6 NA NA NA NA
7 NA 10.0 NA NA
8 NA 6.0 NA NA
[1] "ID" "GP1" "GP2" "GP3"
[5] "GP4" "GP5" "GP6" "GP7"
[9] "GS1" "GS2" "GS3" "GS4"
[13] "GS5" "GS6" "GS7" "GE1"
[17] "GE2" "GE3" "GE4" "GE5"
[21] "GE6" "GF1" "GF2" "GF3"
[25] "GF4" "GF5" "GF6" "GF7"
[29] "O3" "ACT11" "AD1" "PWB_N"
[33] "SWB_N" "EWB_N" "FWB_N" "FACTG_N"
[37] "PWB" "SWB" "EWB" "FWB"
[41] "FACTG" "ADS_N" "FACIT_AD_TOTAL_N" "ADS"
[45] "FACIT_AD_TOTAL" "FACIT_AD_TOI"
PWB SWB EWB FWB
Min. : 7.00 Min. : 8.167 Min. : 7.20 Min. :10.00
1st Qu.:11.83 1st Qu.:17.000 1st Qu.:12.00 1st Qu.:11.25
Median :12.83 Median :18.200 Median :13.20 Median :14.33
Mean :13.05 Mean :16.163 Mean :11.92 Mean :14.22
3rd Qu.:15.17 3rd Qu.:18.200 3rd Qu.:13.20 3rd Qu.:17.30
Max. :17.50 Max. :19.250 Max. :14.00 Max. :18.20
NA's :1 NA's :3 NA's :3 NA's :4
FACTG ADS FACIT_AD_TOTAL FACIT_AD_TOI
Min. :44.70 Min. : 3.000 Min. :47.70 Min. :26.33
1st Qu.:51.23 1st Qu.: 5.500 1st Qu.:55.73 1st Qu.:26.83
Median :55.40 Median : 7.000 Median :61.90 Median :30.10
Mean :54.46 Mean : 7.071 Mean :60.21 Mean :31.72
3rd Qu.:58.63 3rd Qu.: 9.000 3rd Qu.:66.38 3rd Qu.:34.98
Max. :62.33 Max. :10.500 Max. :69.33 Max. :40.33
NA's :4 NA's :1 NA's :4 NA's :4
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.