bump version, release documentation for 0.2

DESCRIPTION

@@ -1,16 +1,16 @@
 Package: AresIndexer
 Type: Package
 Title: Observational Data Research Indexing Package
-Version: 0.1.0
-Date: 2021-02-12
+Version: 0.2.0
+Date: 2022-08-02
 Authors@R: c(
 	person("Frank", "DeFalco", , "[email protected]", role = c("aut", "cre"))
 	)
 Maintainer: Frank J DeFalco <[email protected]>
 Description: The ARES Indexer creates a set of files used by the ARES framework to aid 
     in the exploration of observational research. ARES Indexer leverages output 
     from Achilles and DataQualityDashboad packages.
-License: Apache 2.0
+License: Apache License 2.0
 VignetteBuilder: knitr
 URL: https://github.com/OHDSI/AresIndexer
 Encoding: UTF-8
@@ -20,7 +20,13 @@ Depends:
   R (>= 3.5.0)
 Imports:
   data.table,
-  lubridate
+  lubridate,
+  dplyr,
+  jsonlite,
+  stringr,
+  Achilles,
+  DatabaseConnector,
+  SqlRender
 Suggests: 
     knitr,
     rmarkdown

NAMESPACE

@@ -15,3 +15,4 @@ import(lubridate)
 import(stringr)
 importFrom(data.table,data.table)
 importFrom(data.table,fwrite)
+importFrom(utils,read.csv)

R/AugmentConceptFiles.R

@@ -17,15 +17,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+#' Augment Concept Files
 #'
-#' @details Adds Data Quality and Temporal details to concept data files
+#' @details
+#' Adds Data Quality and Temporal details to concept data files
 #'
 #' @param releaseFolder Folder containing a specific release of a data source
 #'
 #' @import jsonlite
 #' @import dplyr
 #' @importFrom data.table fwrite
 #'
+
 #' @export
 augmentConceptFiles <- function(releaseFolder) {
   dataQualityResultsFile <- file.path(releaseFolder, "dq-result.json")

R/BuildDataQualityIndex.R

@@ -17,6 +17,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+#' Build the Data Quality Index
 #'
 #' @details Creates a data quality stratified network index
 #'

R/BuildExportQueryIndex.R

@@ -17,9 +17,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+#' Export Query Details
 #'
 #' @details Exports a query index that contains links to the queries used to generate all data summaries.
+#'
 #' @name buildExportQueryIndex
+#'
 #' @param outputFolder Path to source folder
 #'
 #' @import jsonlite

R/BuildNetworkIndex.R

@@ -17,6 +17,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+#' Build Network Index
 #'
 #' @details Generates a network index containing data source history across releases including performance, and data quality metrics.
 #'

R/BuildNetworkPerformanceIndex.R

@@ -17,9 +17,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+#' Build Network Performance Index
+#'
 #' @name buildNetworkPerformanceIndex
 #'
-#' @details Builds an index with network performance results across all source folders.
+#' @details Builds an index with network performance results for Achilles and DQD execution across all source folders.
 #' @param sourceFolder Path to source folder
 #'
 #' @return Network performance results object.

R/BuildNetworkUnmappedSourceCodeIndex.R

@@ -17,6 +17,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+#' Build Unmapped Source Code Network Index
 #'
 #' @details Builds an aggregate index of the unmapped source codes across all source folders.
 #'
@@ -30,6 +31,7 @@
 #' @import dplyr
 #' @import stringr
 #' @importFrom data.table fwrite
+#' @importFrom utils read.csv
 #'
 #' @export
 buildNetworkUnmappedSourceCodeIndex <-

docs/.nojekyll

@@ -0,0 +1 @@
+