Skip to content

Commit 4f91320

Browse files
vbshuliarVladyslavmanciniedoardo
authored
Closes #103 - Documentation: Align pharmaverseadam Documentation Style with pharmaversesdtm Reference Page (#97)
* Add json version of the spec * Add title * #103 refresh datasets, update news, regenerate docs * Update readme * #103 update to T * #103 final updates --------- Co-authored-by: Vladyslav <shuliarv@roche.com> Co-authored-by: Edoardo Mancini <edoardo.mancini@roche.com>
1 parent 2d94d3b commit 4f91320

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+20122
-241
lines changed

‎NEWS.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# pharmaverseadam (development version)
22

33
## New features
4-
5-
- Refreshed `{pharmaverseadam}` datasets using `{admiral}` 1.1.1.9027 (development version). (#91)
4+
5+
- Refreshed `{pharmaverseadam}` datasets using `{admiral}` 1.1.1.9019 (development version) `{admiralophtha}` 1.2.0.9001 (development version), `{admiralonco}` 1.2.0, `{admiralvaccine}` 0.4.0, `{pharmaversesdtm}` 1.2.0 (development version). (#103)
66

77
## Documentation
88

9+
- Added more details to README "Documentation Process" section. (#103)
10+
11+
- Improved reference page so that dataset labels are displayed under each dataset name. (#103)
12+
913
<details>
1014
<summary>Developer Notes</summary>
1115

‎R/adae.R‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
#' adae
2-
#'
3-
#' Adverse Events Analysis
1+
# This file is automatically generated by data-raw/create_adams_data.R.
2+
# For updating it please edit inst/extdata/adams-specs.xlsx and rerun create_adams_data.R.
3+
# Manual edits are not recommended, as changes may be overwritten.
44
#'
55
#' @name adae
6+
#' @title Adverse Events Analysis
67
#' @docType data
78
#' @format A data frame with 105 columns:
89
#' \describe{

‎R/adbcva_ophtha.R‎

Lines changed: 13 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
#' adbcva_ophtha
2-
#'
3-
#' Best Corrected Visual Acuity Analysis
1+
# This file is automatically generated by data-raw/create_adams_data.R.
2+
# For updating it please edit inst/extdata/adams-specs.xlsx and rerun create_adams_data.R.
3+
# Manual edits are not recommended, as changes may be overwritten.
44
#'
55
#' @name adbcva_ophtha
6+
#' @title Best Corrected Visual Acuity Analysis
67
#' @docType data
7-
#' @format A data frame with 120 columns:
8+
#' @format A data frame with 71 columns:
89
#' \describe{
910
#' \item{ STUDYID }{Study Identifier}
1011
#' \item{ DOMAIN }{Domain Abbreviation}
@@ -59,71 +60,22 @@
5960
#' \item{ BASEC }{Baseline Value (C)}
6061
#' \item{ CHG }{Change from Baseline}
6162
#' \item{ PCHG }{Percent Change from Baseline}
62-
#' \item{ ASEQ }{Analysis Sequence Number}
63-
#' \item{ SUBJID }{Subject Identifier for the Study}
64-
#' \item{ RFSTDTC }{Subject Reference Start Date/Time}
65-
#' \item{ RFENDTC }{Subject Reference End Date/Time}
66-
#' \item{ RFXSTDTC }{Date/Time of First Study Treatment}
67-
#' \item{ RFXENDTC }{Date/Time of Last Study Treatment}
68-
#' \item{ RFICDTC }{Date/Time of Informed Consent}
69-
#' \item{ RFPENDTC }{Date/Time of End of Participation}
70-
#' \item{ DTHDTC }{Date/Time of Death}
71-
#' \item{ DTHFL }{Subject Death Flag}
72-
#' \item{ SITEID }{Study Site Identifier}
73-
#' \item{ AGE }{Age}
74-
#' \item{ AGEU }{Age Units}
75-
#' \item{ SEX }{Sex}
76-
#' \item{ RACE }{Race}
77-
#' \item{ ETHNIC }{Ethnicity}
78-
#' \item{ ARMCD }{Planned Arm Code}
79-
#' \item{ ARM }{Description of Planned Arm}
80-
#' \item{ ACTARMCD }{Actual Arm Code}
81-
#' \item{ ACTARM }{Description of Actual Arm}
82-
#' \item{ COUNTRY }{Country/Region}
83-
#' \item{ DMDTC }{Date/Time of Collection}
84-
#' \item{ DMDY }{Study Day of Collection}
85-
#' \item{ TRTSDTM }{Datetime of First Exposure to Treatment}
86-
#' \item{ TRTSTMF }{Time of First Exposure Imput. Flag}
87-
#' \item{ TRTEDTM }{Datetime of Last Exposure to Treatment}
88-
#' \item{ TRTETMF }{Time of Last Exposure Imput. Flag}
89-
#' \item{ TRTDURD }{Total Treatment Duration (Days)}
90-
#' \item{ SCRFDT }{Screen Failure Date}
91-
#' \item{ EOSDT }{End of Study Date}
92-
#' \item{ EOSSTT }{End of Study Status}
93-
#' \item{ FRVDT }{Final Retrievel Visit Date}
94-
#' \item{ RANDDT }{Date of Randomization}
95-
#' \item{ DTHDT }{Date of Death}
96-
#' \item{ DTHDTF }{undocumented field}
97-
#' \item{ DTHADY }{Relative Day of Death}
98-
#' \item{ LDDTHELD }{Elapsed Days from Last Dose to Death}
99-
#' \item{ DTHCAUS }{undocumented field}
100-
#' \item{ DTHDOM }{undocumented field}
101-
#' \item{ DTHCGR1 }{undocumented field}
102-
#' \item{ LSTALVDT }{Date Last Known Alive}
103-
#' \item{ SAFFL }{Safety Population Flag}
104-
#' \item{ RACEGR1 }{Pooled Race Group 1}
105-
#' \item{ AGEGR1 }{Pooled Age Group 1}
106-
#' \item{ REGION1 }{Geographic Region 1}
107-
#' \item{ LDDTHGR1 }{Last Dose to Death - Days Elapsed Grp 1}
108-
#' \item{ DTH30FL }{Death Within 30 Days of Last Trt Flag}
109-
#' \item{ DTHA30FL }{Death After 30 Days from Last Trt Flag}
110-
#' \item{ DTHB30FL }{Death Within 30 Days of First Trt Flag}
111-
#' \item{ CRIT1 }{Analysis Criterion 1}
11263
#' \item{ CRIT1FL }{Criterion 1 Evaluation Result Flag}
113-
#' \item{ CRIT2 }{Analysis Criterion 2}
64+
#' \item{ CRIT1 }{Analysis Criterion 1}
11465
#' \item{ CRIT2FL }{Criterion 2 Evaluation Result Flag}
115-
#' \item{ CRIT3 }{Analysis Criterion 3}
66+
#' \item{ CRIT2 }{Analysis Criterion 2}
11667
#' \item{ CRIT3FL }{Criterion 3 Evaluation Result Flag}
117-
#' \item{ CRIT4 }{Analysis Criterion 4}
68+
#' \item{ CRIT3 }{Analysis Criterion 3}
11869
#' \item{ CRIT4FL }{Criterion 4 Evaluation Result Flag}
119-
#' \item{ CRIT5 }{Analysis Criterion 5}
70+
#' \item{ CRIT4 }{Analysis Criterion 4}
12071
#' \item{ CRIT5FL }{Criterion 5 Evaluation Result Flag}
121-
#' \item{ CRIT6 }{Analysis Criterion 6}
72+
#' \item{ CRIT5 }{Analysis Criterion 5}
12273
#' \item{ CRIT6FL }{Criterion 6 Evaluation Result Flag}
123-
#' \item{ CRIT7 }{Analysis Criterion 7}
74+
#' \item{ CRIT6 }{Analysis Criterion 6}
12475
#' \item{ CRIT7FL }{Criterion 7 Evaluation Result Flag}
125-
#' \item{ CRIT8 }{Analysis Criterion 8}
76+
#' \item{ CRIT7 }{Analysis Criterion 7}
12677
#' \item{ CRIT8FL }{Criterion 8 Evaluation Result Flag}
78+
#' \item{ CRIT8 }{Analysis Criterion 8}
12779
#' \item{ AVALCA1N }{Analysis Value Category 1 (N)}
12880
#' \item{ AVALCAT1 }{Analysis Value Category 1}
12981
#' }

‎R/adce_vaccine.R‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
#' adce_vaccine
2-
#'
3-
#' Clinical Events Analysis for Vaccine
1+
# This file is automatically generated by data-raw/create_adams_data.R.
2+
# For updating it please edit inst/extdata/adams-specs.xlsx and rerun create_adams_data.R.
3+
# Manual edits are not recommended, as changes may be overwritten.
44
#'
55
#' @name adce_vaccine
6+
#' @title Clinical Events Analysis for Vaccine
67
#' @docType data
78
#' @format A data frame with 56 columns:
89
#' \describe{

‎R/adcm.R‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
#' adcm
2-
#'
3-
#' Concomitant Medications Analysis
1+
# This file is automatically generated by data-raw/create_adams_data.R.
2+
# For updating it please edit inst/extdata/adams-specs.xlsx and rerun create_adams_data.R.
3+
# Manual edits are not recommended, as changes may be overwritten.
44
#'
55
#' @name adcm
6+
#' @title Concomitant Medications Analysis
67
#' @docType data
78
#' @format A data frame with 95 columns:
89
#' \describe{

‎R/adeg.R‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
#' adeg
2-
#'
3-
#' Electrocardiogram Tests Analysis
1+
# This file is automatically generated by data-raw/create_adams_data.R.
2+
# For updating it please edit inst/extdata/adams-specs.xlsx and rerun create_adams_data.R.
3+
# Manual edits are not recommended, as changes may be overwritten.
44
#'
55
#' @name adeg
6+
#' @title Electrocardiogram Tests Analysis
67
#' @docType data
78
#' @format A data frame with 108 columns:
89
#' \describe{

‎R/adex.R‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
#' adex
2-
#'
3-
#' Exposure Analysis
1+
# This file is automatically generated by data-raw/create_adams_data.R.
2+
# For updating it please edit inst/extdata/adams-specs.xlsx and rerun create_adams_data.R.
3+
# Manual edits are not recommended, as changes may be overwritten.
44
#'
55
#' @name adex
6+
#' @title Exposure Analysis
67
#' @docType data
78
#' @format A data frame with 92 columns:
89
#' \describe{

‎R/adface_vaccine.R‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
#' adface_vaccine
2-
#'
3-
#' Findings About Clinical Events Analysis
1+
# This file is automatically generated by data-raw/create_adams_data.R.
2+
# For updating it please edit inst/extdata/adams-specs.xlsx and rerun create_adams_data.R.
3+
# Manual edits are not recommended, as changes may be overwritten.
44
#'
55
#' @name adface_vaccine
6+
#' @title Findings About Clinical Events Analysis
67
#' @docType data
78
#' @format A data frame with 61 columns:
89
#' \describe{

‎R/adis_vaccine.R‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
#' adis_vaccine
2-
#'
3-
#' Immunogenicity Specimen Assessments
1+
# This file is automatically generated by data-raw/create_adams_data.R.
2+
# For updating it please edit inst/extdata/adams-specs.xlsx and rerun create_adams_data.R.
3+
# Manual edits are not recommended, as changes may be overwritten.
44
#'
55
#' @name adis_vaccine
6+
#' @title Immunogenicity Specimen Assessments
67
#' @docType data
78
#' @format A data frame with 102 columns:
89
#' \describe{

‎R/adlb.R‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
#' adlb
2-
#'
3-
#' Laboratory Analysis
1+
# This file is automatically generated by data-raw/create_adams_data.R.
2+
# For updating it please edit inst/extdata/adams-specs.xlsx and rerun create_adams_data.R.
3+
# Manual edits are not recommended, as changes may be overwritten.
44
#'
55
#' @name adlb
6+
#' @title Laboratory Analysis
67
#' @docType data
78
#' @format A data frame with 115 columns:
89
#' \describe{

0 commit comments

Comments
 (0)