Skip to content

Commit 8dc2995

Browse files
ymarconymarcon
committed
More dataset doc
1 parent 4a95723 commit 8dc2995

32 files changed

Lines changed: 638 additions & 91 deletions

‎DESCRIPTION‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ License: LGPL (>= 2.1)
2626
URL: http://www.datashield.ac.uk https://doi.org/10.1093/ije/dyu188
2727
BugReports: https://github.com/datashield/DSLite
2828
RoxygenNote: 7.1.0
29+
Roxygen: list(markdown = TRUE)
2930
VignetteBuilder: knitr
3031
Encoding: UTF-8
3132
Collate:

‎R/DSLiteDriver.R‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ setClass("DSLiteDriver", contains = "DSDriver")
1313

1414
#' Create a DSLite driver
1515
#'
16-
#' Convenient function for creating a [DSLiteDriver] object.
16+
#' Convenient function for creating a DSLiteDriver object.
1717
#'
1818
#' @import methods
1919
#' @import DSI

‎R/data.cnsim.R‎

Lines changed: 69 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
#' DataSHIELD login data for the CNSIM simulated datasets
22
#'
3-
#' DataSHIELD login data.frame for connecting with CNSIM datasets.
3+
#' DataSHIELD login data.frame for connecting with CNSIM datasets. The CNSIM datasets contain
4+
#' synthetic data based on a model derived from the participants of the 1958 Birth Cohort,
5+
#' as part of the obesity methodological development project. These datasets do contain some
6+
#' NA values.
7+
#'
8+
#' | **Field** | **Description** | **Type** | **Note** |
9+
#' | ------------------ | -------------------------------- | -------- | -------- |
10+
#' | server | Server/study name | char ||
11+
#' | url | Server/study URL | char | DSLiteServer instance symbol name |
12+
#' | user | User name | char | Always empty for DSLiteServer |
13+
#' | password | User password | char | Always empty for DSLiteServer |
14+
#' | table | Table unique name | char | As registered in the DSLiteServer |
15+
#' | options | Connection options | char | Always empty for DSLiteServer |
16+
#' | driver | Connection driver | char | DSLiteServer |
417
#'
518
#' @name logindata.dslite.cnsim
619
#' @docType data
@@ -9,9 +22,24 @@ NULL
922

1023
#' Simulated dataset CNSIM 1
1124
#'
12-
#' Simulated dataset CNSIM 1, in a data.frame with 2163 observations of 11 harmonized variables:
13-
#' LAB_TSC, LAB_TRIG, LAB_HDL, LAB_GLUC_ADJUSTED, PM_BMI_CONTINUOUS, DIS_CVA, MEDI_LPD, DIS_DIAB,
14-
#' DIS_AMI, GENDER, PM_BMI_CATEGORICAL.
25+
#' Simulated dataset CNSIM 1, in a data.frame with 2163 observations of 11 harmonized
26+
#' variables. The CNSIM dataset contains synthetic data based on a model derived from the
27+
#' participants of the 1958 Birth Cohort, as part of the obesity methodological development
28+
#' project. This dataset does contain some NA values.
29+
#'
30+
#' | **Variable** | **Description** | **Type** | **Note** |
31+
#' | ------------------ | -------------------------------- | -------- | -------- |
32+
#' | LAB_TSC | Total Serum Cholesterol | numeric | mmol/L |
33+
#' | LAB_TRIG | Triglycerides | numeric | mmol/L |
34+
#' | LAB_HDL | HDL Cholesterol | numeric | mmol/L |
35+
#' | LAB_GLUC_ADJUSTED | Non-Fasting Glucose | numeric | mmol/L |
36+
#' | PM_BMI_CONTINUOUS | Body Mass Index (continuous) | numeric | kg/m2 |
37+
#' | DIS_CVA | History of Stroke | factor | 0 = Never had stroke, 1 = Has had stroke|
38+
#' | MEDI_LPD | Current Use of Lipid Lowering Medication (from categorical assessment item) | factor | 0 = Not currently using lipid lowering medication, 1 = Currently using lipid lowering medication|
39+
#' | DIS_DIAB | History of Diabetes | factor | 0 = Never had diabetes, 1 = Has had diabetes |
40+
#' | DIS_AMI | History of Myocardial Infarction | factor | 0 = Never had myocardial infarction, 1 = Has had myocardial infarction |
41+
#' | GENDER | Gender | factor | 0 = Female, 1 = Male |
42+
#' | PM_BMI_CATEGORICAL | Body Mass Index (categorical) | factor | 1 = Less than 25 kg/m2, 2 = 25 to 30 kg/m2, 3 = Over 30 kg/m2 |
1543
#'
1644
#' @name CNSIM1
1745
#' @docType data
@@ -20,9 +48,25 @@ NULL
2048

2149
#' Simulated dataset CNSIM 2
2250
#'
23-
#' Simulated dataset CNSIM 1, in a data.frame with 3088 observations of 11 harmonized variables:
24-
#' LAB_TSC, LAB_TRIG, LAB_HDL, LAB_GLUC_ADJUSTED, PM_BMI_CONTINUOUS, DIS_CVA, MEDI_LPD, DIS_DIAB,
25-
#' DIS_AMI, GENDER, PM_BMI_CATEGORICAL.
51+
#' Simulated dataset CNSIM 1, in a data.frame with 3088 observations of 11 harmonized variables
52+
#' variables. The CNSIM dataset contains synthetic data based on a model derived from the
53+
#' participants of the 1958 Birth Cohort, as part of the obesity methodological development
54+
#' project. This dataset does contain some NA values.
55+
56+
#'
57+
#' | **Variable** | **Description** | **Type** | **Note** |
58+
#' | ------------------ | -------------------------------- | -------- | -------- |
59+
#' | LAB_TSC | Total Serum Cholesterol | numeric | mmol/L |
60+
#' | LAB_TRIG | Triglycerides | numeric | mmol/L |
61+
#' | LAB_HDL | HDL Cholesterol | numeric | mmol/L |
62+
#' | LAB_GLUC_ADJUSTED | Non-Fasting Glucose | numeric | mmol/L |
63+
#' | PM_BMI_CONTINUOUS | Body Mass Index (continuous) | numeric | kg/m2 |
64+
#' | DIS_CVA | History of Stroke | factor | 0 = Never had stroke, 1 = Has had stroke|
65+
#' | MEDI_LPD | Current Use of Lipid Lowering Medication (from categorical assessment item) | factor | 0 = Not currently using lipid lowering medication, 1 = Currently using lipid lowering medication|
66+
#' | DIS_DIAB | History of Diabetes | factor | 0 = Never had diabetes, 1 = Has had diabetes |
67+
#' | DIS_AMI | History of Myocardial Infarction | factor | 0 = Never had myocardial infarction, 1 = Has had myocardial infarction |
68+
#' | GENDER | Gender | factor | 0 = Female, 1 = Male |
69+
#' | PM_BMI_CATEGORICAL | Body Mass Index (categorical) | factor | 1 = Less than 25 kg/m2, 2 = 25 to 30 kg/m2, 3 = Over 30 kg/m2 |
2670
#'
2771
#' @name CNSIM2
2872
#' @docType data
@@ -31,9 +75,24 @@ NULL
3175

3276
#' Simulated dataset CNSIM 3
3377
#'
34-
#' Simulated dataset CNSIM 1, in a data.frame with 4128 observations of 11 harmonized variables:
35-
#' LAB_TSC, LAB_TRIG, LAB_HDL, LAB_GLUC_ADJUSTED, PM_BMI_CONTINUOUS, DIS_CVA, MEDI_LPD, DIS_DIAB,
36-
#' DIS_AMI, GENDER, PM_BMI_CATEGORICAL.
78+
#' Simulated dataset CNSIM 1, in a data.frame with 4128 observations of 11 harmonized variables
79+
#' variables. The CNSIM dataset contains synthetic data based on a model derived from the
80+
#' participants of the 1958 Birth Cohort, as part of the obesity methodological development
81+
#' project. This dataset does contain some NA values.
82+
#'
83+
#' | **Variable** | **Description** | **Type** | **Note** |
84+
#' | ------------------ | -------------------------------- | -------- | -------- |
85+
#' | LAB_TSC | Total Serum Cholesterol | numeric | mmol/L |
86+
#' | LAB_TRIG | Triglycerides | numeric | mmol/L |
87+
#' | LAB_HDL | HDL Cholesterol | numeric | mmol/L |
88+
#' | LAB_GLUC_ADJUSTED | Non-Fasting Glucose | numeric | mmol/L |
89+
#' | PM_BMI_CONTINUOUS | Body Mass Index (continuous) | numeric | kg/m2 |
90+
#' | DIS_CVA | History of Stroke | factor | 0 = Never had stroke, 1 = Has had stroke|
91+
#' | MEDI_LPD | Current Use of Lipid Lowering Medication (from categorical assessment item) | factor | 0 = Not currently using lipid lowering medication, 1 = Currently using lipid lowering medication|
92+
#' | DIS_DIAB | History of Diabetes | factor | 0 = Never had diabetes, 1 = Has had diabetes |
93+
#' | DIS_AMI | History of Myocardial Infarction | factor | 0 = Never had myocardial infarction, 1 = Has had myocardial infarction |
94+
#' | GENDER | Gender | factor | 0 = Female, 1 = Male |
95+
#' | PM_BMI_CATEGORICAL | Body Mass Index (categorical) | factor | 1 = Less than 25 kg/m2, 2 = 25 to 30 kg/m2, 3 = Over 30 kg/m2 |
3796
#'
3897
#' @name CNSIM3
3998
#' @docType data

‎R/data.dasim.R‎

Lines changed: 65 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
#' DataSHIELD login data for the DASIM simulated datasets
22
#'
3-
#' DataSHIELD login data.frame for connecting with DASIM datasets.
3+
#' DataSHIELD login data.frame for connecting with DASIM datasets. The DASIM datasets contain
4+
#' synthetic data based on a model derived from the participants of the 1958 Birth Cohort, as
5+
#' part of the obesity methodological development project. These datasets do not contain some
6+
#' NA values.
7+
#'
8+
#' | **Field** | **Description** | **Type** | **Note** |
9+
#' | ------------------ | -------------------------------- | -------- | -------- |
10+
#' | server | Server/study name | char ||
11+
#' | url | Server/study URL | char | DSLiteServer instance symbol name |
12+
#' | user | User name | char | Always empty for DSLiteServer |
13+
#' | password | User password | char | Always empty for DSLiteServer |
14+
#' | table | Table unique name | char | As registered in the DSLiteServer |
15+
#' | options | Connection options | char | Always empty for DSLiteServer |
16+
#' | driver | Connection driver | char | DSLiteServer |
417
#'
518
#' @name logindata.dslite.dasim
619
#' @docType data
@@ -9,9 +22,23 @@ NULL
922

1023
#' Simulated dataset DASIM 1
1124
#'
12-
#' Simulated dataset DASIM 1, in a data.frame with 10000 observations of 10 harmonized variables:
13-
#' LAB_TSC, LAB_TRIG, LAB_HDL, LAB_GLUC_FASTING, PM_BMI_CONTINUOUS, DIS_CVA, DIS_DIAB, DIS_AMI,
14-
#' GENDER, PM_BMI_CATEGORICAL.
25+
#' Simulated dataset DASIM 1, in a data.frame with 10000 observations of 10 harmonized variables.
26+
#' The DASIM dataset contains synthetic data based on a model derived from the participants of
27+
#' the 1958 Birth Cohort, as part of the obesity methodological development project. This dataset
28+
#' does not contain some NA values.
29+
#'
30+
#' | **Variable** | **Description** | **Type** | **Note** |
31+
#' | ------------------ | -------------------------------- | -------- | -------- |
32+
#' | LAB_TSC | Total Serum Cholesterol | numeric | mmol/L |
33+
#' | LAB_TRIG | Triglycerides | numeric | mmol/L |
34+
#' | LAB_HDL | HDL Cholesterol | numeric | mmol/L |
35+
#' | LAB_GLUC_FASTING | Fasting Glucose | numeric | mmol/L |
36+
#' | PM_BMI_CONTINUOUS | Body Mass Index (continuous) | numeric | kg/m2 |
37+
#' | DIS_CVA | History of Stroke | factor | 0 = Never had stroke, 1 = Has had stroke|
38+
#' | DIS_DIAB | History of Diabetes | factor | 0 = Never had diabetes, 1 = Has had diabetes|
39+
#' | DIS_AMI | History of Myocardial Infarction | factor | 0 = Never had myocardial infarction, 1 = Has had myocardial infarction|
40+
#' | GENDER | Gender | factor | 0 = Female, 1 = Male|
41+
#' | PM_BMI_CATEGORICAL | Body Mass Index (categorical) | factor | 1 = Less than 25 kg/m2, 2 = 25 to 30 kg/m2, 3 = Over 30 kg/m2|
1542
#'
1643
#' @name DASIM1
1744
#' @docType data
@@ -20,9 +47,23 @@ NULL
2047

2148
#' Simulated dataset DASIM 2
2249
#'
23-
#' Simulated dataset DASIM 2, in a data.frame with 10000 observations of 10 harmonized variables:
24-
#' LAB_TSC, LAB_TRIG, LAB_HDL, LAB_GLUC_FASTING, PM_BMI_CONTINUOUS, DIS_CVA, DIS_DIAB, DIS_AMI,
25-
#' GENDER, PM_BMI_CATEGORICAL.
50+
#' Simulated dataset DASIM 2, in a data.frame with 10000 observations of 10 harmonized variables.
51+
#' The DASIM dataset contains synthetic data based on a model derived from the participants of
52+
#' the 1958 Birth Cohort, as part of the obesity methodological development project. This dataset
53+
#' does not contain some NA values.
54+
#'
55+
#' | **Variable** | **Description** | **Type** | **Note** |
56+
#' | ------------------ | -------------------------------- | -------- | -------- |
57+
#' | LAB_TSC | Total Serum Cholesterol | numeric | mmol/L |
58+
#' | LAB_TRIG | Triglycerides | numeric | mmol/L |
59+
#' | LAB_HDL | HDL Cholesterol | numeric | mmol/L |
60+
#' | LAB_GLUC_FASTING | Fasting Glucose | numeric | mmol/L |
61+
#' | PM_BMI_CONTINUOUS | Body Mass Index (continuous) | numeric | kg/m2 |
62+
#' | DIS_CVA | History of Stroke | factor | 0 = Never had stroke, 1 = Has had stroke|
63+
#' | DIS_DIAB | History of Diabetes | factor | 0 = Never had diabetes, 1 = Has had diabetes|
64+
#' | DIS_AMI | History of Myocardial Infarction | factor | 0 = Never had myocardial infarction, 1 = Has had myocardial infarction|
65+
#' | GENDER | Gender | factor | 0 = Female, 1 = Male|
66+
#' | PM_BMI_CATEGORICAL | Body Mass Index (categorical) | factor | 1 = Less than 25 kg/m2, 2 = 25 to 30 kg/m2, 3 = Over 30 kg/m2|
2667
#'
2768
#' @name DASIM2
2869
#' @docType data
@@ -31,9 +72,23 @@ NULL
3172

3273
#' Simulated dataset DASIM 3
3374
#'
34-
#' Simulated dataset DASIM 3, in a data.frame with 10000 observations of 10 harmonized variables:
35-
#' LAB_TSC, LAB_TRIG, LAB_HDL, LAB_GLUC_FASTING, PM_BMI_CONTINUOUS, DIS_CVA, DIS_DIAB, DIS_AMI,
36-
#' GENDER, PM_BMI_CATEGORICAL.
75+
#' Simulated dataset DASIM 3, in a data.frame with 10000 observations of 10 harmonized variables.
76+
#' The DASIM dataset contains synthetic data based on a model derived from the participants of
77+
#' the 1958 Birth Cohort, as part of the obesity methodological development project. This dataset
78+
#' does not contain some NA values.
79+
#'
80+
#' | **Variable** | **Description** | **Type** | **Note** |
81+
#' | ------------------ | -------------------------------- | -------- | -------- |
82+
#' | LAB_TSC | Total Serum Cholesterol | numeric | mmol/L |
83+
#' | LAB_TRIG | Triglycerides | numeric | mmol/L |
84+
#' | LAB_HDL | HDL Cholesterol | numeric | mmol/L |
85+
#' | LAB_GLUC_FASTING | Fasting Glucose | numeric | mmol/L |
86+
#' | PM_BMI_CONTINUOUS | Body Mass Index (continuous) | numeric | kg/m2 |
87+
#' | DIS_CVA | History of Stroke | factor | 0 = Never had stroke, 1 = Has had stroke|
88+
#' | DIS_DIAB | History of Diabetes | factor | 0 = Never had diabetes, 1 = Has had diabetes|
89+
#' | DIS_AMI | History of Myocardial Infarction | factor | 0 = Never had myocardial infarction, 1 = Has had myocardial infarction|
90+
#' | GENDER | Gender | factor | 0 = Female, 1 = Male|
91+
#' | PM_BMI_CATEGORICAL | Body Mass Index (categorical) | factor | 1 = Less than 25 kg/m2, 2 = 25 to 30 kg/m2, 3 = Over 30 kg/m2|
3792
#'
3893
#' @name DASIM3
3994
#' @docType data

‎R/data.discordant.R‎

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,29 @@
33
#' DataSHIELD login data.frame for connecting with DISCORDANT datasets which purpose is to test
44
#' datasets that are NOT harmonized.
55
#'
6+
#' | **Field** | **Description** | **Type** | **Note** |
7+
#' | ------------------ | -------------------------------- | -------- | -------- |
8+
#' | server | Server/study name | char ||
9+
#' | url | Server/study URL | char | DSLiteServer instance symbol name |
10+
#' | user | User name | char | Always empty for DSLiteServer |
11+
#' | password | User password | char | Always empty for DSLiteServer |
12+
#' | table | Table unique name | char | As registered in the DSLiteServer |
13+
#' | options | Connection options | char | Always empty for DSLiteServer |
14+
#' | driver | Connection driver | char | DSLiteServer |
15+
#'
616
#' @name logindata.dslite.discordant
717
#' @docType data
818
#' @keywords data
919
NULL
1020

1121
#' Simulated dataset DISCORDANT 1
1222
#'
13-
#' Simulated dataset DISCORDANT 1, in a data.frame with 12 observations of 2 discordant variables:
14-
#' A, B.
23+
#' Simulated dataset DISCORDANT 1, in a data.frame with 12 observations of 2 discordant variables.
24+
#'
25+
#' | **Variable** | **Description** | **Type** |
26+
#' | ------------------ | -------------------------------- | -------- |
27+
#' | A | Dummy data | integer |
28+
#' | B | Dummy data | integer |
1529
#'
1630
#' @name DISCORDANT_STUDY1
1731
#' @docType data
@@ -20,8 +34,13 @@ NULL
2034

2135
#' Simulated dataset DISCORDANT 2
2236
#'
23-
#' Simulated dataset DISCORDANT 2, in a data.frame with 12 observations of 2 discordant variables:
24-
#' A, C.
37+
#' Simulated dataset DISCORDANT 2, in a data.frame with 12 observations of 2 discordant variables.
38+
#'
39+
#' | **Variable** | **Description** | **Type** |
40+
#' | ------------------ | -------------------------------- | -------- |
41+
#' | A | Dummy data | integer |
42+
#' | C | Dummy data | integer |
43+
#'
2544
#'
2645
#' @name DISCORDANT_STUDY2
2746
#' @docType data
@@ -30,8 +49,12 @@ NULL
3049

3150
#' Simulated dataset DISCORDANT 3
3251
#'
33-
#' Simulated dataset DISCORDANT 3, in a data.frame with 12 observations of 2 discordant variables:
34-
#' B, C.
52+
#' Simulated dataset DISCORDANT 3, in a data.frame with 12 observations of 2 discordant variables.
53+
#'
54+
#' | **Variable** | **Description** | **Type** |
55+
#' | ------------------ | -------------------------------- | -------- |
56+
#' | B | Dummy data | integer |
57+
#' | C | Dummy data | integer |
3558
#'
3659
#' @name DISCORDANT_STUDY3
3760
#' @docType data

0 commit comments

Comments
 (0)