diff --git a/R/REDCapR-package.R b/R/REDCapR-package.R index a7d741ba..9718f1ce 100644 --- a/R/REDCapR-package.R +++ b/R/REDCapR-package.R @@ -6,6 +6,7 @@ #' #' @description #' +#' Comprehensive documentation is also available at https://ouhscbbmc.github.io/REDCapR/. #' #' Much of this package has been developed to support the needs of the following projects. We appreciate the support. #' * *OUHSC CCAN Independent Evaluation of the State of Oklahoma Competitive Maternal, Infant, and Early Childhood Home Visiting ([MIECHV](http://mchb.hrsa.gov/programs/homevisiting/)) Project*. [HRSA/ACF D89MC23154](https://perf-data.hrsa.gov/mchb/DGISReports/Abstract/AbstractDetails.aspx?Source=TVIS&GrantNo=D89MC23154&FY=2012). David Bard, PI, OUHSC; 2011-2015. diff --git a/README.md b/README.md index 71df8f44..129db0c7 100644 --- a/README.md +++ b/README.md @@ -50,13 +50,6 @@ The [ouhscbbmc.github.io/REDCapR](https://ouhscbbmc.github.io/REDCapR) site des Also checkout the other packages that exist for communicating with REDCap, which are listed in the [REDCap Tools](http://redcap-tools.github.io/projects/) directory. -### Build Status - -| [GitHub](https://github.com/OuhscBbmc/REDCapR) | [Travis-CI](https://travis-ci.org/OuhscBbmc/REDCapR/builds) | [AppVeyor](https://ci.appveyor.com/project/wibeasley/redcapr/history) | [Coveralls](https://coveralls.io/r/OuhscBbmc/REDCapR) | -| :----- | :---------------------------: | :-----------------------------: | :-------: | -| [Master](https://github.com/OuhscBbmc/REDCapR/tree/master) | [![Build Status](https://travis-ci.org/OuhscBbmc/REDCapR.svg?branch=master)](https://travis-ci.org/OuhscBbmc/REDCapR) | [![Build status](https://ci.appveyor.com/api/projects/status/0i41tn0n2jo4pd2k/branch/master?svg=true)](https://ci.appveyor.com/project/wibeasley/redcapr/branch/master) | [![Coverage Status](https://coveralls.io/repos/github/OuhscBbmc/REDCapR/badge.svg?branch=master)](https://coveralls.io/github/OuhscBbmc/REDCapR?branch=master) | -| [Dev](https://github.com/OuhscBbmc/REDCapR/tree/dev) | [![Build Status](https://travis-ci.org/OuhscBbmc/REDCapR.svg?branch=dev)](https://travis-ci.org/OuhscBbmc/REDCapR) | [![Build status](https://ci.appveyor.com/api/projects/status/0i41tn0n2jo4pd2k/branch/dev?svg=true)](https://ci.appveyor.com/project/wibeasley/redcapr/branch/dev) | [![Coverage Status](https://coveralls.io/repos/github/OuhscBbmc/REDCapR/badge.svg?branch=dev)](https://coveralls.io/github/OuhscBbmc/REDCapR?branch=dev) | -| | *Ubuntu LTS* | *Windows Server* | *Test Coverage* | ### Collaborative Development We encourage input and collaboration. If you're familiar with GitHub and R packages, feel free to submit a [pull request](https://github.com/OuhscBbmc/REDCapR/pulls). If you'd like to report a bug or make a suggestion, please create a GitHub [issue](https://github.com/OuhscBbmc/REDCapR/issues); issues are a usually a good place to ask public questions too. However, feel free to email Will (). Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md); by participating in this project you agree to abide by its terms. We have some starting material described in the [`./documentation-for-developers/`](https://github.com/OuhscBbmc/REDCapR/tree/master/documentation-for-developers) directory. @@ -81,7 +74,13 @@ Thanks, [Department of Pediatrics](https://www.oumedicine.com/department-of-pediatrics), [Biomedical & Behavioral Research Core](http://ouhsc.edu/BBMC/). -### Package Characteristics +### Build Status and Package Characteristics + +| [GitHub](https://github.com/OuhscBbmc/REDCapR) | [Travis-CI](https://travis-ci.org/OuhscBbmc/REDCapR/builds) | [AppVeyor](https://ci.appveyor.com/project/wibeasley/redcapr/history) | [Coveralls](https://coveralls.io/r/OuhscBbmc/REDCapR) | +| :----- | :---------------------------: | :-----------------------------: | :-------: | +| [Master](https://github.com/OuhscBbmc/REDCapR/tree/master) | [![Build Status](https://travis-ci.org/OuhscBbmc/REDCapR.svg?branch=master)](https://travis-ci.org/OuhscBbmc/REDCapR) | [![Build status](https://ci.appveyor.com/api/projects/status/0i41tn0n2jo4pd2k/branch/master?svg=true)](https://ci.appveyor.com/project/wibeasley/redcapr/branch/master) | [![Coverage Status](https://coveralls.io/repos/github/OuhscBbmc/REDCapR/badge.svg?branch=master)](https://coveralls.io/github/OuhscBbmc/REDCapR?branch=master) | +| [Dev](https://github.com/OuhscBbmc/REDCapR/tree/dev) | [![Build Status](https://travis-ci.org/OuhscBbmc/REDCapR.svg?branch=dev)](https://travis-ci.org/OuhscBbmc/REDCapR) | [![Build status](https://ci.appveyor.com/api/projects/status/0i41tn0n2jo4pd2k/branch/dev?svg=true)](https://ci.appveyor.com/project/wibeasley/redcapr/branch/dev) | [![Coverage Status](https://coveralls.io/repos/github/OuhscBbmc/REDCapR/badge.svg?branch=dev)](https://coveralls.io/github/OuhscBbmc/REDCapR?branch=dev) | +| | *Ubuntu LTS* | *Windows Server* | *Test Coverage* | | Key | Value | | :--- | :----- | diff --git a/docs/articles/BasicREDCapROperations.html b/docs/articles/BasicREDCapROperations.html index 44dd7256..623a3d83 100644 --- a/docs/articles/BasicREDCapROperations.html +++ b/docs/articles/BasicREDCapROperations.html @@ -96,7 +96,7 @@
The data dictionary describing 16 fields was read from REDCap in 0.3 seconds.  The http status code was 200.
2 records and 1 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
-
Starting to read 2 records  at 2018-07-11 22:44:39.
+
Starting to read 2 records  at 2018-07-12 00:22:15.
Reading batch 1 of 1, with subjects 1 through 3 (ie, 2 unique subject records).
-
2 records and 24 columns were read from REDCap in 0.2 seconds.  The http status code was 200.
+
2 records and 24 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
#Return only records with IDs of 1 and 3 (alternate way)
 desired_records_v2 <- "1, 3"
 ds_some_rows_v2 <- redcap_read(
@@ -617,8 +617,8 @@ 

records_collapsed = desired_records_v2 )$data

The data dictionary describing 16 fields was read from REDCap in 0.3 seconds.  The http status code was 200.
-
2 records and 1 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
-
Starting to read 2 records  at 2018-07-11 22:44:41.
+
2 records and 1 columns were read from REDCap in 0.4 seconds.  The http status code was 200.
+
Starting to read 2 records  at 2018-07-12 00:22:16.
Reading batch 1 of 1, with subjects 1 through 3 (ie, 2 unique subject records).
2 records and 24 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
ds_some_rows_v2 #Inspect the returned dataset
@@ -862,11 +862,11 @@

token = token, fields = desired_fields_v1 )$data -
The data dictionary describing 16 fields was read from REDCap in 0.2 seconds.  The http status code was 200.
-
5 records and 1 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
-
Starting to read 5 records  at 2018-07-11 22:44:42.
+
The data dictionary describing 16 fields was read from REDCap in 0.3 seconds.  The http status code was 200.
+
5 records and 1 columns were read from REDCap in 0.2 seconds.  The http status code was 200.
+
Starting to read 5 records  at 2018-07-12 00:22:18.
Reading batch 1 of 1, with subjects 1 through 5 (ie, 5 unique subject records).
-
5 records and 3 columns were read from REDCap in 1.1 seconds.  The http status code was 200.
+
5 records and 3 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
#Return only the fields record_id, name_first, and age (alternate way)
 desired_fields_v2 <- "record_id, name_first, age"
 ds_some_fields_v2 <- redcap_read(
@@ -875,8 +875,8 @@ 

fields_collapsed = desired_fields_v2 )$data

The data dictionary describing 16 fields was read from REDCap in 0.3 seconds.  The http status code was 200.
-
5 records and 1 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
-
Starting to read 5 records  at 2018-07-11 22:44:44.
+
5 records and 1 columns were read from REDCap in 0.4 seconds.  The http status code was 200.
+
Starting to read 5 records  at 2018-07-12 00:22:20.
Reading batch 1 of 1, with subjects 1 through 5 (ie, 5 unique subject records).
5 records and 3 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
ds_some_fields_v2 #Inspect the returned dataset
@@ -963,9 +963,9 @@

token = token, fields = desired_fields_v3 )$data -
The data dictionary describing 16 fields was read from REDCap in 0.3 seconds.  The http status code was 200.
+
The data dictionary describing 16 fields was read from REDCap in 0.4 seconds.  The http status code was 200.
5 records and 1 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
-
Starting to read 5 records  at 2018-07-11 22:44:46.
+
Starting to read 5 records  at 2018-07-12 00:22:21.
Reading batch 1 of 1, with subjects 1 through 5 (ie, 5 unique subject records).
5 records and 3 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
ds_some_fields_v3 #Examine the these three variables.
@@ -1056,8 +1056,8 @@

records = desired_records_v3 )$data
The data dictionary describing 16 fields was read from REDCap in 0.3 seconds.  The http status code was 200.
-
2 records and 1 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
-
Starting to read 2 records  at 2018-07-11 22:44:47.
+
2 records and 1 columns were read from REDCap in 0.4 seconds.  The http status code was 200.
+
Starting to read 2 records  at 2018-07-12 00:22:23.
Reading batch 1 of 1, with subjects 3 through 5 (ie, 2 unique subject records).
2 records and 24 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
ds_some_rows_v3 #Examine the results.
@@ -1314,9 +1314,9 @@

)
The data dictionary describing 16 fields was read from REDCap in 0.3 seconds.  The http status code was 200.
5 records and 1 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
-
Starting to read 5 records  at 2018-07-11 22:44:49.
+
Starting to read 5 records  at 2018-07-12 00:22:24.
Reading batch 1 of 1, with subjects 1 through 5 (ie, 5 unique subject records).
-
5 records and 3 columns were read from REDCap in 0.5 seconds.  The http status code was 200.
+
5 records and 3 columns were read from REDCap in 0.3 seconds.  The http status code was 200.
all_information #Inspect the additional information
$data
   record_id name_first age
@@ -1333,7 +1333,7 @@ 

[1] "200" $outcome_messages -[1] "5 records and 3 columns were read from REDCap in 0.5 seconds. The http status code was 200." +[1] "5 records and 3 columns were read from REDCap in 0.3 seconds. The http status code was 200." $records_collapsed [1] "" @@ -1351,7 +1351,7 @@

[1] "" $elapsed_seconds -[1] 1.603175

+[1] 1.503323
@@ -1368,7 +1368,7 @@

language (EN) collate en_US.UTF-8 tz America/Chicago - date 2018-07-11 + date 2018-07-12 ─ Packages ────────────────────────────────────────────────────────────── package * version date source @@ -1425,7 +1425,7 @@

xml2 1.2.0 2018-01-24 CRAN (R 3.4.3) yaml 2.1.19 2018-05-01 CRAN (R 3.4.4)

-

Report rendered by wibeasley at 2018-07-11, 22:44 -0500 in 15 seconds.

+

Report rendered by wibeasley at 2018-07-12, 00:22 -0500 in 15 seconds.

diff --git a/docs/articles/SecurityDatabase.html b/docs/articles/SecurityDatabase.html index a9ea6903..76e2c077 100644 --- a/docs/articles/SecurityDatabase.html +++ b/docs/articles/SecurityDatabase.html @@ -96,7 +96,7 @@