forked from pharmaverse/admiral
-
Notifications
You must be signed in to change notification settings - Fork 0
/
atoxgr_criteria_ctcv4.Rd
56 lines (55 loc) · 2.63 KB
/
atoxgr_criteria_ctcv4.Rd
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/data.R
\docType{data}
\name{atoxgr_criteria_ctcv4}
\alias{atoxgr_criteria_ctcv4}
\title{Metadata Holding Grading Criteria for NCI-CTCAEv4}
\format{
An object of class \code{tbl_df} (inherits from \code{tbl}, \code{data.frame}) with 40 rows and 13 columns.
}
\usage{
atoxgr_criteria_ctcv4
}
\description{
Metadata Holding Grading Criteria for NCI-CTCAEv4
}
\details{
This metadata has its origin in the ADLB Grading Spec Excel file which ships with \code{{admiral}}
and can be accessed using \code{system.file("adlb_grading/adlb_grading_spec.xlsx", package = "admiral")}
in sheet = "NCICTCAEv4".
The dataset contained in there has the following columns:
\itemize{
\item \code{SOC}: variable to hold the SOC of the lab test criteria.
\item \code{TERM}: variable to hold the term describing the criteria applied to a particular lab test,
eg. 'Anemia' or 'INR Increased'. Note: the variable is case insensitive.
\item \verb{Grade 1}: Criteria defining lab value as Grade 1.
\item \verb{Grade 2}: Criteria defining lab value as Grade 2.
\item \verb{Grade 3}: Criteria defining lab value as Grade 3.
\item \verb{Grade 4}: Criteria defining lab value as Grade 4.
\item \verb{Grade 5}: Criteria defining lab value as Grade 5.
\item \code{Definition}: Holds the definition of the lab test abnormality.
\item \code{GRADE_CRITERIA_CODE}: variable to hold code that creates grade based on defined criteria.
\item \code{SI_UNIT_CHECK}: variable to hold unit of particular lab test. Used to check against input data
if criteria is based on absolute values.
\item \code{VAR_CHECK}: List of variables required to implement lab grade criteria. Use to check against
input data.
\item \code{DIRECTION}: variable to hold the direction of the abnormality of a particular lab test
value. 'L' is for LOW values, 'H' is for HIGH values. Note: the variable is case insensitive.
\item \code{COMMENT}: Holds any information regarding rationale behind implementation of grading criteria.
}
Note: Variables \code{SOC}, \code{TERM}, \verb{Grade 1}, \verb{Grade 2},\verb{Grade 3},\verb{Grade 4},\verb{Grade 5}, \code{Definition}
are from the source document on NCI-CTC website defining the grading criteria.
\href{https://ctep.cancer.gov/protocoldevelopment/electronic_applications/ctc.htm#ctc_40}{\strong{Common Terminology Criteria for Adverse Events (CTCAE)v4.0}}
From these variables only 'TERM' is used in the {admiral} code, the rest are for information and
tracability only.
}
\seealso{
Other metadata:
\code{\link{atoxgr_criteria_ctcv5}},
\code{\link{dose_freq_lookup}}
}
\author{
Gordon Miller
}
\concept{metadata}
\keyword{metadata}