From c13ee04a2aa0d8eae2bc7f653e6a2aa90cb12c7a Mon Sep 17 00:00:00 2001 From: Frank DeFalco Date: Tue, 2 Aug 2022 12:59:04 -0400 Subject: [PATCH] bump version, release documentation for 0.2 --- DESCRIPTION | 14 +- NAMESPACE | 1 + R/AugmentConceptFiles.R | 5 +- R/BuildDataQualityIndex.R | 1 + R/BuildExportQueryIndex.R | 3 + R/BuildNetworkIndex.R | 1 + R/BuildNetworkPerformanceIndex.R | 4 +- R/BuildNetworkUnmappedSourceCodeIndex.R | 2 + docs/.nojekyll | 1 + docs/404.html | 100 +++++ docs/LICENSE-text.html | 275 +++++++++++++ docs/authors.html | 95 +++++ docs/bootstrap-toc.css | 60 +++ docs/bootstrap-toc.js | 159 ++++++++ docs/docsearch.css | 148 +++++++ docs/docsearch.js | 85 ++++ docs/index.html | 129 ++++++ docs/link.svg | 12 + docs/pkgdown.css | 384 ++++++++++++++++++ docs/pkgdown.js | 108 +++++ docs/pkgdown.yml | 6 + docs/reference/augmentConceptFiles.html | 90 ++++ .../buildDataQualityHistoryIndex.html | 86 ++++ docs/reference/buildDataQualityIndex.html | 101 +++++ .../buildDataSourceHistoryIndex.html | 86 ++++ docs/reference/buildExportQueryIndex.html | 87 ++++ docs/reference/buildNetworkIndex.html | 102 +++++ .../buildNetworkPerformanceIndex.html | 93 +++++ .../buildNetworkUnmappedSourceCodeIndex.html | 100 +++++ docs/reference/getSourceReleaseKey.html | 80 ++++ docs/reference/index.html | 110 +++++ docs/sitemap.xml | 45 ++ extras/PackageMaintenance.R | 0 man/augmentConceptFiles.Rd | 17 + man/buildDataQualityIndex.Rd | 23 ++ man/buildExportQueryIndex.Rd | 14 + man/buildNetworkIndex.Rd | 24 ++ man/buildNetworkPerformanceIndex.Rd | 17 + man/buildNetworkUnmappedSourceCodeIndex.Rd | 22 + 39 files changed, 2684 insertions(+), 6 deletions(-) create mode 100644 docs/.nojekyll create mode 100644 docs/404.html create mode 100644 docs/LICENSE-text.html create mode 100644 docs/authors.html create mode 100644 docs/bootstrap-toc.css create mode 100644 docs/bootstrap-toc.js create mode 100644 docs/docsearch.css create mode 100644 docs/docsearch.js create mode 100644 docs/index.html create mode 100644 docs/link.svg create mode 100644 docs/pkgdown.css create mode 100644 docs/pkgdown.js create mode 100644 docs/pkgdown.yml create mode 100644 docs/reference/augmentConceptFiles.html create mode 100644 docs/reference/buildDataQualityHistoryIndex.html create mode 100644 docs/reference/buildDataQualityIndex.html create mode 100644 docs/reference/buildDataSourceHistoryIndex.html create mode 100644 docs/reference/buildExportQueryIndex.html create mode 100644 docs/reference/buildNetworkIndex.html create mode 100644 docs/reference/buildNetworkPerformanceIndex.html create mode 100644 docs/reference/buildNetworkUnmappedSourceCodeIndex.html create mode 100644 docs/reference/getSourceReleaseKey.html create mode 100644 docs/reference/index.html create mode 100644 docs/sitemap.xml create mode 100644 extras/PackageMaintenance.R create mode 100644 man/augmentConceptFiles.Rd create mode 100644 man/buildDataQualityIndex.Rd create mode 100644 man/buildExportQueryIndex.Rd create mode 100644 man/buildNetworkIndex.Rd create mode 100644 man/buildNetworkPerformanceIndex.Rd create mode 100644 man/buildNetworkUnmappedSourceCodeIndex.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 98a26ff..197104d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ 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", , "fdefalco@ohdsi.org", role = c("aut", "cre")) ) @@ -10,7 +10,7 @@ Maintainer: Frank J DeFalco 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 diff --git a/NAMESPACE b/NAMESPACE index 5df3d4d..7d0c214 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -15,3 +15,4 @@ import(lubridate) import(stringr) importFrom(data.table,data.table) importFrom(data.table,fwrite) +importFrom(utils,read.csv) diff --git a/R/AugmentConceptFiles.R b/R/AugmentConceptFiles.R index 284d1cd..ccbd656 100644 --- a/R/AugmentConceptFiles.R +++ b/R/AugmentConceptFiles.R @@ -17,8 +17,10 @@ # 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 #' @@ -26,6 +28,7 @@ #' @import dplyr #' @importFrom data.table fwrite #' + #' @export augmentConceptFiles <- function(releaseFolder) { dataQualityResultsFile <- file.path(releaseFolder, "dq-result.json") diff --git a/R/BuildDataQualityIndex.R b/R/BuildDataQualityIndex.R index c57ee19..2d2956d 100644 --- a/R/BuildDataQualityIndex.R +++ b/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 #' diff --git a/R/BuildExportQueryIndex.R b/R/BuildExportQueryIndex.R index ec37f05..d1f142e 100644 --- a/R/BuildExportQueryIndex.R +++ b/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 diff --git a/R/BuildNetworkIndex.R b/R/BuildNetworkIndex.R index ac4ceb7..c047532 100644 --- a/R/BuildNetworkIndex.R +++ b/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. #' diff --git a/R/BuildNetworkPerformanceIndex.R b/R/BuildNetworkPerformanceIndex.R index 32e33f7..820da9c 100644 --- a/R/BuildNetworkPerformanceIndex.R +++ b/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. diff --git a/R/BuildNetworkUnmappedSourceCodeIndex.R b/R/BuildNetworkUnmappedSourceCodeIndex.R index db0faac..ba09600 100644 --- a/R/BuildNetworkUnmappedSourceCodeIndex.R +++ b/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 <- diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ + diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..0f8374d --- /dev/null +++ b/docs/404.html @@ -0,0 +1,100 @@ + + + + + + + +Page not found (404) • AresIndexer + + + + + + + + + + + +
+
+ + + + +
+
+
+

Page not found (404)

+
+ +Content not found. Please use links in the navbar. + +
+ + + +
+ + + +
+

+

Developed by Frank DeFalco.

+
+ +
+

+

Site built with pkgdown 2.0.6.

+
+ +
+
+ + + + + + + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html new file mode 100644 index 0000000..5eb97f9 --- /dev/null +++ b/docs/LICENSE-text.html @@ -0,0 +1,275 @@ + +License • AresIndexer + + +
+
+ + + +
+
+
+

License

+
+ +
                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+ +
+ + + +
+ + + +
+

Developed by Frank DeFalco.

+
+ +
+

Site built with pkgdown 2.0.6.

+
+ +
+ + + + + + + + diff --git a/docs/authors.html b/docs/authors.html new file mode 100644 index 0000000..9d408a2 --- /dev/null +++ b/docs/authors.html @@ -0,0 +1,95 @@ + +Authors and Citation • AresIndexer + + +
+
+ + + +
+
+
+
+

Authors

+
+ + +
  • +

    Frank DeFalco. Author, maintainer. +

    +
    • +
+
+
+

Citation

+ Source: DESCRIPTION +
+
+ + +

DeFalco F (2022). +AresIndexer: Observational Data Research Indexing Package. +R package version 0.2.0, https://github.com/OHDSI/AresIndexer. +

+ 
@Manual{,
+  title = {AresIndexer: Observational Data Research Indexing Package},
+  author = {Frank DeFalco},
+  year = {2022},
+  note = {R package version 0.2.0},
+  url = {https://github.com/OHDSI/AresIndexer},
+}
+ +
+ +
+ + + +
+

Developed by Frank DeFalco.

+
+ +
+

Site built with pkgdown 2.0.6.

+
+ +
+ + + + + + + + diff --git a/docs/bootstrap-toc.css b/docs/bootstrap-toc.css new file mode 100644 index 0000000..5a85941 --- /dev/null +++ b/docs/bootstrap-toc.css @@ -0,0 +1,60 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ + +/* modified from https://github.com/twbs/bootstrap/blob/94b4076dd2efba9af71f0b18d4ee4b163aa9e0dd/docs/assets/css/src/docs.css#L548-L601 */ + +/* All levels of nav */ +nav[data-toggle='toc'] .nav > li > a { + display: block; + padding: 4px 20px; + font-size: 13px; + font-weight: 500; + color: #767676; +} +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 19px; + color: #563d7c; + text-decoration: none; + background-color: transparent; + border-left: 1px solid #563d7c; +} +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 18px; + font-weight: bold; + color: #563d7c; + background-color: transparent; + border-left: 2px solid #563d7c; +} + +/* Nav: second level (shown on .active) */ +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} +nav[data-toggle='toc'] .nav .nav > li > a { + padding-top: 1px; + padding-bottom: 1px; + padding-left: 30px; + font-size: 12px; + font-weight: normal; +} +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 29px; +} +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 28px; + font-weight: 500; +} + +/* from https://github.com/twbs/bootstrap/blob/e38f066d8c203c3e032da0ff23cd2d6098ee2dd6/docs/assets/css/src/docs.css#L631-L634 */ +nav[data-toggle='toc'] .nav > .active > ul { + display: block; +} diff --git a/docs/bootstrap-toc.js b/docs/bootstrap-toc.js new file mode 100644 index 0000000..1cdd573 --- /dev/null +++ b/docs/bootstrap-toc.js @@ -0,0 +1,159 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ +(function() { + 'use strict'; + + window.Toc = { + helpers: { + // return all matching elements in the set, or their descendants + findOrFilter: function($el, selector) { + // http://danielnouri.org/notes/2011/03/14/a-jquery-find-that-also-finds-the-root-element/ + // http://stackoverflow.com/a/12731439/358804 + var $descendants = $el.find(selector); + return $el.filter(selector).add($descendants).filter(':not([data-toc-skip])'); + }, + + generateUniqueIdBase: function(el) { + var text = $(el).text(); + var anchor = text.trim().toLowerCase().replace(/[^A-Za-z0-9]+/g, '-'); + return anchor || el.tagName.toLowerCase(); + }, + + generateUniqueId: function(el) { + var anchorBase = this.generateUniqueIdBase(el); + for (var i = 0; ; i++) { + var anchor = anchorBase; + if (i > 0) { + // add suffix + anchor += '-' + i; + } + // check if ID already exists + if (!document.getElementById(anchor)) { + return anchor; + } + } + }, + + generateAnchor: function(el) { + if (el.id) { + return el.id; + } else { + var anchor = this.generateUniqueId(el); + el.id = anchor; + return anchor; + } + }, + + createNavList: function() { + return $(''); + }, + + createChildNavList: function($parent) { + var $childList = this.createNavList(); + $parent.append($childList); + return $childList; + }, + + generateNavEl: function(anchor, text) { + var $a = $(''); + $a.attr('href', '#' + anchor); + $a.text(text); + var $li = $('
  • '); + $li.append($a); + return $li; + }, + + generateNavItem: function(headingEl) { + var anchor = this.generateAnchor(headingEl); + var $heading = $(headingEl); + var text = $heading.data('toc-text') || $heading.text(); + return this.generateNavEl(anchor, text); + }, + + // Find the first heading level (`

    `, then `

    `, etc.) that has more than one element. Defaults to 1 (for `

    `). + getTopLevel: function($scope) { + for (var i = 1; i <= 6; i++) { + var $headings = this.findOrFilter($scope, 'h' + i); + if ($headings.length > 1) { + return i; + } + } + + return 1; + }, + + // returns the elements for the top level, and the next below it + getHeadings: function($scope, topLevel) { + var topSelector = 'h' + topLevel; + + var secondaryLevel = topLevel + 1; + var secondarySelector = 'h' + secondaryLevel; + + return this.findOrFilter($scope, topSelector + ',' + secondarySelector); + }, + + getNavLevel: function(el) { + return parseInt(el.tagName.charAt(1), 10); + }, + + populateNav: function($topContext, topLevel, $headings) { + var $context = $topContext; + var $prevNav; + + var helpers = this; + $headings.each(function(i, el) { + var $newNav = helpers.generateNavItem(el); + var navLevel = helpers.getNavLevel(el); + + // determine the proper $context + if (navLevel === topLevel) { + // use top level + $context = $topContext; + } else if ($prevNav && $context === $topContext) { + // create a new level of the tree and switch to it + $context = helpers.createChildNavList($prevNav); + } // else use the current $context + + $context.append($newNav); + + $prevNav = $newNav; + }); + }, + + parseOps: function(arg) { + var opts; + if (arg.jquery) { + opts = { + $nav: arg + }; + } else { + opts = arg; + } + opts.$scope = opts.$scope || $(document.body); + return opts; + } + }, + + // accepts a jQuery object, or an options object + init: function(opts) { + opts = this.helpers.parseOps(opts); + + // ensure that the data attribute is in place for styling + opts.$nav.attr('data-toggle', 'toc'); + + var $topContext = this.helpers.createChildNavList(opts.$nav); + var topLevel = this.helpers.getTopLevel(opts.$scope); + var $headings = this.helpers.getHeadings(opts.$scope, topLevel); + this.helpers.populateNav($topContext, topLevel, $headings); + } + }; + + $(function() { + $('nav[data-toggle="toc"]').each(function(i, el) { + var $nav = $(el); + Toc.init($nav); + }); + }); +})(); diff --git a/docs/docsearch.css b/docs/docsearch.css new file mode 100644 index 0000000..e5f1fe1 --- /dev/null +++ b/docs/docsearch.css @@ -0,0 +1,148 @@ +/* Docsearch -------------------------------------------------------------- */ +/* + Source: https://github.com/algolia/docsearch/ + License: MIT +*/ + +.algolia-autocomplete { + display: block; + -webkit-box-flex: 1; + -ms-flex: 1; + flex: 1 +} + +.algolia-autocomplete .ds-dropdown-menu { + width: 100%; + min-width: none; + max-width: none; + padding: .75rem 0; + background-color: #fff; + background-clip: padding-box; + border: 1px solid rgba(0, 0, 0, .1); + box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175); +} + +@media (min-width:768px) { + .algolia-autocomplete .ds-dropdown-menu { + width: 175% + } +} + +.algolia-autocomplete .ds-dropdown-menu::before { + display: none +} + +.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] { + padding: 0; + background-color: rgb(255,255,255); + border: 0; + max-height: 80vh; +} + +.algolia-autocomplete .ds-dropdown-menu .ds-suggestions { + margin-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion { + padding: 0; + overflow: visible +} + +.algolia-autocomplete .algolia-docsearch-suggestion--category-header { + padding: .125rem 1rem; + margin-top: 0; + font-size: 1.3em; + font-weight: 500; + color: #00008B; + border-bottom: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--wrapper { + float: none; + padding-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column { + float: none; + width: auto; + padding: 0; + text-align: left +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content { + float: none; + width: auto; + padding: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content::before { + display: none +} + +.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header { + padding-top: .75rem; + margin-top: .75rem; + border-top: 1px solid rgba(0, 0, 0, .1) +} + +.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column { + display: block; + padding: .1rem 1rem; + margin-bottom: 0.1; + font-size: 1.0em; + font-weight: 400 + /* display: none */ +} + +.algolia-autocomplete .algolia-docsearch-suggestion--title { + display: block; + padding: .25rem 1rem; + margin-bottom: 0; + font-size: 0.9em; + font-weight: 400 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--text { + padding: 0 1rem .5rem; + margin-top: -.25rem; + font-size: 0.8em; + font-weight: 400; + line-height: 1.25 +} + +.algolia-autocomplete .algolia-docsearch-footer { + width: 110px; + height: 20px; + z-index: 3; + margin-top: 10.66667px; + float: right; + font-size: 0; + line-height: 0; +} + +.algolia-autocomplete .algolia-docsearch-footer--logo { + background-image: url("data:image/svg+xml;utf8,"); + background-repeat: no-repeat; + background-position: 50%; + background-size: 100%; + overflow: hidden; + text-indent: -9000px; + width: 100%; + height: 100%; + display: block; + transform: translate(-8px); +} + +.algolia-autocomplete .algolia-docsearch-suggestion--highlight { + color: #FF8C00; + background: rgba(232, 189, 54, 0.1) +} + + +.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight { + box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5) +} + +.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content { + background-color: rgba(192, 192, 192, .15) +} diff --git a/docs/docsearch.js b/docs/docsearch.js new file mode 100644 index 0000000..b35504c --- /dev/null +++ b/docs/docsearch.js @@ -0,0 +1,85 @@ +$(function() { + + // register a handler to move the focus to the search bar + // upon pressing shift + "/" (i.e. "?") + $(document).on('keydown', function(e) { + if (e.shiftKey && e.keyCode == 191) { + e.preventDefault(); + $("#search-input").focus(); + } + }); + + $(document).ready(function() { + // do keyword highlighting + /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */ + var mark = function() { + + var referrer = document.URL ; + var paramKey = "q" ; + + if (referrer.indexOf("?") !== -1) { + var qs = referrer.substr(referrer.indexOf('?') + 1); + var qs_noanchor = qs.split('#')[0]; + var qsa = qs_noanchor.split('&'); + var keyword = ""; + + for (var i = 0; i < qsa.length; i++) { + var currentParam = qsa[i].split('='); + + if (currentParam.length !== 2) { + continue; + } + + if (currentParam[0] == paramKey) { + keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20")); + } + } + + if (keyword !== "") { + $(".contents").unmark({ + done: function() { + $(".contents").mark(keyword); + } + }); + } + } + }; + + mark(); + }); +}); + +/* Search term highlighting ------------------------------*/ + +function matchedWords(hit) { + var words = []; + + var hierarchy = hit._highlightResult.hierarchy; + // loop to fetch from lvl0, lvl1, etc. + for (var idx in hierarchy) { + words = words.concat(hierarchy[idx].matchedWords); + } + + var content = hit._highlightResult.content; + if (content) { + words = words.concat(content.matchedWords); + } + + // return unique words + var words_uniq = [...new Set(words)]; + return words_uniq; +} + +function updateHitURL(hit) { + + var words = matchedWords(hit); + var url = ""; + + if (hit.anchor) { + url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor; + } else { + url = hit.url + '?q=' + escape(words.join(" ")); + } + + return url; +} diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..3a2c317 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,129 @@ + + + + + + + +Observational Data Research Indexing Package • AresIndexer + + + + + + + + + + + + +
    +
    + + + + +
    +
    +
    +

    AresIndexer +

    +

    R Package that indexes observational data results to provide content to the ARES interface.

    +
    +
    + + +
    + + +
    +

    +

    Developed by Frank DeFalco.

    +
    + +
    +

    +

    Site built with pkgdown 2.0.6.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/link.svg b/docs/link.svg new file mode 100644 index 0000000..88ad827 --- /dev/null +++ b/docs/link.svg @@ -0,0 +1,12 @@ + + + + + + diff --git a/docs/pkgdown.css b/docs/pkgdown.css new file mode 100644 index 0000000..80ea5b8 --- /dev/null +++ b/docs/pkgdown.css @@ -0,0 +1,384 @@ +/* Sticky footer */ + +/** + * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/ + * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css + * + * .Site -> body > .container + * .Site-content -> body > .container .row + * .footer -> footer + * + * Key idea seems to be to ensure that .container and __all its parents__ + * have height set to 100% + * + */ + +html, body { + height: 100%; +} + +body { + position: relative; +} + +body > .container { + display: flex; + height: 100%; + flex-direction: column; +} + +body > .container .row { + flex: 1 0 auto; +} + +footer { + margin-top: 45px; + padding: 35px 0 36px; + border-top: 1px solid #e5e5e5; + color: #666; + display: flex; + flex-shrink: 0; +} +footer p { + margin-bottom: 0; +} +footer div { + flex: 1; +} +footer .pkgdown { + text-align: right; +} +footer p { + margin-bottom: 0; +} + +img.icon { + float: right; +} + +/* Ensure in-page images don't run outside their container */ +.contents img { + max-width: 100%; + height: auto; +} + +/* Fix bug in bootstrap (only seen in firefox) */ +summary { + display: list-item; +} + +/* Typographic tweaking ---------------------------------*/ + +.contents .page-header { + margin-top: calc(-60px + 1em); +} + +dd { + margin-left: 3em; +} + +/* Section anchors ---------------------------------*/ + +a.anchor { + display: none; + margin-left: 5px; + width: 20px; + height: 20px; + + background-image: url(./link.svg); + background-repeat: no-repeat; + background-size: 20px 20px; + background-position: center center; +} + +h1:hover .anchor, +h2:hover .anchor, +h3:hover .anchor, +h4:hover .anchor, +h5:hover .anchor, +h6:hover .anchor { + display: inline-block; +} + +/* Fixes for fixed navbar --------------------------*/ + +.contents h1, .contents h2, .contents h3, .contents h4 { + padding-top: 60px; + margin-top: -40px; +} + +/* Navbar submenu --------------------------*/ + +.dropdown-submenu { + position: relative; +} + +.dropdown-submenu>.dropdown-menu { + top: 0; + left: 100%; + margin-top: -6px; + margin-left: -1px; + border-radius: 0 6px 6px 6px; +} + +.dropdown-submenu:hover>.dropdown-menu { + display: block; +} + +.dropdown-submenu>a:after { + display: block; + content: " "; + float: right; + width: 0; + height: 0; + border-color: transparent; + border-style: solid; + border-width: 5px 0 5px 5px; + border-left-color: #cccccc; + margin-top: 5px; + margin-right: -10px; +} + +.dropdown-submenu:hover>a:after { + border-left-color: #ffffff; +} + +.dropdown-submenu.pull-left { + float: none; +} + +.dropdown-submenu.pull-left>.dropdown-menu { + left: -100%; + margin-left: 10px; + border-radius: 6px 0 6px 6px; +} + +/* Sidebar --------------------------*/ + +#pkgdown-sidebar { + margin-top: 30px; + position: -webkit-sticky; + position: sticky; + top: 70px; +} + +#pkgdown-sidebar h2 { + font-size: 1.5em; + margin-top: 1em; +} + +#pkgdown-sidebar h2:first-child { + margin-top: 0; +} + +#pkgdown-sidebar .list-unstyled li { + margin-bottom: 0.5em; +} + +/* bootstrap-toc tweaks ------------------------------------------------------*/ + +/* All levels of nav */ + +nav[data-toggle='toc'] .nav > li > a { + padding: 4px 20px 4px 6px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; +} + +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 5px; + color: inherit; + border-left: 1px solid #878787; +} + +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 5px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; + border-left: 2px solid #878787; +} + +/* Nav: second level (shown on .active) */ + +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} + +nav[data-toggle='toc'] .nav .nav > li > a { + padding-left: 16px; + font-size: 1.35rem; +} + +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 15px; +} + +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 15px; + font-weight: 500; + font-size: 1.35rem; +} + +/* orcid ------------------------------------------------------------------- */ + +.orcid { + font-size: 16px; + color: #A6CE39; + /* margins are required by official ORCID trademark and display guidelines */ + margin-left:4px; + margin-right:4px; + vertical-align: middle; +} + +/* Reference index & topics ----------------------------------------------- */ + +.ref-index th {font-weight: normal;} + +.ref-index td {vertical-align: top; min-width: 100px} +.ref-index .icon {width: 40px;} +.ref-index .alias {width: 40%;} +.ref-index-icons .alias {width: calc(40% - 40px);} +.ref-index .title {width: 60%;} + +.ref-arguments th {text-align: right; padding-right: 10px;} +.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px} +.ref-arguments .name {width: 20%;} +.ref-arguments .desc {width: 80%;} + +/* Nice scrolling for wide elements --------------------------------------- */ + +table { + display: block; + overflow: auto; +} + +/* Syntax highlighting ---------------------------------------------------- */ + +pre, code, pre code { + background-color: #f8f8f8; + color: #333; +} +pre, pre code { + white-space: pre-wrap; + word-break: break-all; + overflow-wrap: break-word; +} + +pre { + border: 1px solid #eee; +} + +pre .img, pre .r-plt { + margin: 5px 0; +} + +pre .img img, pre .r-plt img { + background-color: #fff; +} + +code a, pre a { + color: #375f84; +} + +a.sourceLine:hover { + text-decoration: none; +} + +.fl {color: #1514b5;} +.fu {color: #000000;} /* function */ +.ch,.st {color: #036a07;} /* string */ +.kw {color: #264D66;} /* keyword */ +.co {color: #888888;} /* comment */ + +.error {font-weight: bolder;} +.warning {font-weight: bolder;} + +/* Clipboard --------------------------*/ + +.hasCopyButton { + position: relative; +} + +.btn-copy-ex { + position: absolute; + right: 0; + top: 0; + visibility: hidden; +} + +.hasCopyButton:hover button.btn-copy-ex { + visibility: visible; +} + +/* headroom.js ------------------------ */ + +.headroom { + will-change: transform; + transition: transform 200ms linear; +} +.headroom--pinned { + transform: translateY(0%); +} +.headroom--unpinned { + transform: translateY(-100%); +} + +/* mark.js ----------------------------*/ + +mark { + background-color: rgba(255, 255, 51, 0.5); + border-bottom: 2px solid rgba(255, 153, 51, 0.3); + padding: 1px; +} + +/* vertical spacing after htmlwidgets */ +.html-widget { + margin-bottom: 10px; +} + +/* fontawesome ------------------------ */ + +.fab { + font-family: "Font Awesome 5 Brands" !important; +} + +/* don't display links in code chunks when printing */ +/* source: https://stackoverflow.com/a/10781533 */ +@media print { + code a:link:after, code a:visited:after { + content: ""; + } +} + +/* Section anchors --------------------------------- + Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71 +*/ + +div.csl-bib-body { } +div.csl-entry { + clear: both; +} +.hanging-indent div.csl-entry { + margin-left:2em; + text-indent:-2em; +} +div.csl-left-margin { + min-width:2em; + float:left; +} +div.csl-right-inline { + margin-left:2em; + padding-left:1em; +} +div.csl-indent { + margin-left: 2em; +} diff --git a/docs/pkgdown.js b/docs/pkgdown.js new file mode 100644 index 0000000..6f0eee4 --- /dev/null +++ b/docs/pkgdown.js @@ -0,0 +1,108 @@ +/* http://gregfranko.com/blog/jquery-best-practices/ */ +(function($) { + $(function() { + + $('.navbar-fixed-top').headroom(); + + $('body').css('padding-top', $('.navbar').height() + 10); + $(window).resize(function(){ + $('body').css('padding-top', $('.navbar').height() + 10); + }); + + $('[data-toggle="tooltip"]').tooltip(); + + var cur_path = paths(location.pathname); + var links = $("#navbar ul li a"); + var max_length = -1; + var pos = -1; + for (var i = 0; i < links.length; i++) { + if (links[i].getAttribute("href") === "#") + continue; + // Ignore external links + if (links[i].host !== location.host) + continue; + + var nav_path = paths(links[i].pathname); + + var length = prefix_length(nav_path, cur_path); + if (length > max_length) { + max_length = length; + pos = i; + } + } + + // Add class to parent
  • , and enclosing
  • if in dropdown + if (pos >= 0) { + var menu_anchor = $(links[pos]); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); + + function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); + } + + // Returns -1 if not found + function prefix_length(needle, haystack) { + if (needle.length > haystack.length) + return(-1); + + // Special case for length-0 haystack, since for loop won't run + if (haystack.length === 0) { + return(needle.length === 0 ? 0 : -1); + } + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(i); + } + + return(haystack.length); + } + + /* Clipboard --------------------------*/ + + function changeTooltipMessage(element, msg) { + var tooltipOriginalTitle=element.getAttribute('data-original-title'); + element.setAttribute('data-original-title', msg); + $(element).tooltip('show'); + element.setAttribute('data-original-title', tooltipOriginalTitle); + } + + if(ClipboardJS.isSupported()) { + $(document).ready(function() { + var copyButton = ""; + + $("div.sourceCode").addClass("hasCopyButton"); + + // Insert copy buttons: + $(copyButton).prependTo(".hasCopyButton"); + + // Initialize tooltips: + $('.btn-copy-ex').tooltip({container: 'body'}); + + // Initialize clipboard: + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { + text: function(trigger) { + return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); + } + }); + + clipboardBtnCopies.on('success', function(e) { + changeTooltipMessage(e.trigger, 'Copied!'); + e.clearSelection(); + }); + + clipboardBtnCopies.on('error', function() { + changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); + }); + }); + } +})(window.jQuery || window.$) diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml new file mode 100644 index 0000000..db23d5a --- /dev/null +++ b/docs/pkgdown.yml @@ -0,0 +1,6 @@ +pandoc: '2.18' +pkgdown: 2.0.6 +pkgdown_sha: ~ +articles: {} +last_built: 2022-08-02T16:57Z + diff --git a/docs/reference/augmentConceptFiles.html b/docs/reference/augmentConceptFiles.html new file mode 100644 index 0000000..4f06a37 --- /dev/null +++ b/docs/reference/augmentConceptFiles.html @@ -0,0 +1,90 @@ + +Augment Concept Files — augmentConceptFiles • AresIndexer + + +
    +
    + + + +
    +
    +
    +

    Augment Concept Files

    + Source: R/AugmentConceptFiles.R + +
    + +
    +

    Augment Concept Files

    +
    + +
    + 
    augmentConceptFiles(releaseFolder)
    +
    + +
    +

    Arguments

    +
    releaseFolder
    +

    Folder containing a specific release of a data source

    + +
    +
    +

    Details

    +

    Adds Data Quality and Temporal details to concept data files

    +
    + +
    + +
    + + +
    +

    Developed by Frank DeFalco.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/buildDataQualityHistoryIndex.html b/docs/reference/buildDataQualityHistoryIndex.html new file mode 100644 index 0000000..ea275e6 --- /dev/null +++ b/docs/reference/buildDataQualityHistoryIndex.html @@ -0,0 +1,86 @@ + +Data Quality Historical Indexing — buildDataQualityHistoryIndex • AresIndexer + + +
    +
    + + + +
    +
    +
    +

    Data Quality Historical Indexing

    + Source: R/BuildDataQualityHistoryIndex.R + +
    + +
    +

    Data Quality Historical Indexing

    +
    + +
    + 
    buildDataQualityHistoryIndex(sourceFolder)
    +
    + +
    +

    Arguments

    +
    sourceFolder
    +

    Location of a data source source folder

    + +
    + +
    + +
    + + +
    +

    Developed by Frank DeFalco.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/buildDataQualityIndex.html b/docs/reference/buildDataQualityIndex.html new file mode 100644 index 0000000..e5c9d47 --- /dev/null +++ b/docs/reference/buildDataQualityIndex.html @@ -0,0 +1,101 @@ + +Build the Data Quality Index — buildDataQualityIndex • AresIndexer + + +
    +
    + + + +
    +
    +
    +

    Build the Data Quality Index

    + Source: R/BuildDataQualityIndex.R + +
    + +
    +

    Build the Data Quality Index

    +
    + +
    + 
    buildDataQualityIndex(sourceFolders, outputFolder)
    +
    + +
    +

    Arguments

    +
    sourceFolders
    +

    A vector of folder locations that contain the dq-result.json files +to be included in the network data quality index.

    + + +
    outputFolder
    +

    Location of the Ares data folder

    + +
    +
    +

    Value

    + + +

    A data frame with a the necessary network data quality data

    +
    +
    +

    Details

    +

    Creates a data quality stratified network index

    +
    + +
    + +
    + + +
    +

    Developed by Frank DeFalco.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/buildDataSourceHistoryIndex.html b/docs/reference/buildDataSourceHistoryIndex.html new file mode 100644 index 0000000..c72151b --- /dev/null +++ b/docs/reference/buildDataSourceHistoryIndex.html @@ -0,0 +1,86 @@ + +Data Quality Historical Indexing — buildDataSourceHistoryIndex • AresIndexer + + +
    +
    + + + +
    +
    +
    +

    Data Quality Historical Indexing

    + Source: R/BuildDataSourceHistoryIndex.R + +
    + +
    +

    Data Quality Historical Indexing

    +
    + +
    + 
    buildDataSourceHistoryIndex(sourceFolder)
    +
    + +
    +

    Arguments

    +
    sourceFolder
    +

    Location of a data source folder

    + +
    + +
    + +
    + + +
    +

    Developed by Frank DeFalco.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/buildExportQueryIndex.html b/docs/reference/buildExportQueryIndex.html new file mode 100644 index 0000000..4b15b8f --- /dev/null +++ b/docs/reference/buildExportQueryIndex.html @@ -0,0 +1,87 @@ + +Export Query Details — buildExportQueryIndex • AresIndexer + + +
    +
    + + + +
    +
    +
    +

    Export Query Details

    + Source: R/BuildExportQueryIndex.R + +
    + +
    +

    Export Query Details

    +
    + + +
    +

    Arguments

    +
    outputFolder
    +

    Path to source folder

    + +
    +
    +

    Details

    +

    Exports a query index that contains links to the queries used to generate all data summaries.

    +
    + +
    + +
    + + +
    +

    Developed by Frank DeFalco.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/buildNetworkIndex.html b/docs/reference/buildNetworkIndex.html new file mode 100644 index 0000000..0240f29 --- /dev/null +++ b/docs/reference/buildNetworkIndex.html @@ -0,0 +1,102 @@ + +Build Network Index — buildNetworkIndex • AresIndexer + + +
    +
    + + + +
    +
    +
    +

    Build Network Index

    + Source: R/BuildNetworkIndex.R + +
    + +
    +

    Build Network Index

    +
    + +
    + 
    buildNetworkIndex(sourceFolders, outputFolder)
    +
    + +
    +

    Arguments

    +
    sourceFolders
    +

    A vector of folder locations that contain the files +exported from Achilles in the ARES Option format (Achilles::exportAO) +to be included in the network data quality index.

    + + +
    outputFolder
    +

    The location of the Ares data folder.

    + +
    +
    +

    Value

    + + +

    The JSON object that is written to the ARES data folder (outputFolder parameter).

    +
    +
    +

    Details

    +

    Generates a network index containing data source history across releases including performance, and data quality metrics.

    +
    + +
    + +
    + + +
    +

    Developed by Frank DeFalco.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/buildNetworkPerformanceIndex.html b/docs/reference/buildNetworkPerformanceIndex.html new file mode 100644 index 0000000..6cc015f --- /dev/null +++ b/docs/reference/buildNetworkPerformanceIndex.html @@ -0,0 +1,93 @@ + +Build Network Performance Index — buildNetworkPerformanceIndex • AresIndexer + + +
    +
    + + + +
    +
    +
    +

    Build Network Performance Index

    + Source: R/BuildNetworkPerformanceIndex.R + +
    + +
    +

    Build Network Performance Index

    +
    + + +
    +

    Arguments

    +
    sourceFolder
    +

    Path to source folder

    + +
    +
    +

    Value

    + + +

    Network performance results object.

    +
    +
    +

    Details

    +

    Builds an index with network performance results for Achilles and DQD execution across all source folders.

    +
    + +
    + +
    + + +
    +

    Developed by Frank DeFalco.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/buildNetworkUnmappedSourceCodeIndex.html b/docs/reference/buildNetworkUnmappedSourceCodeIndex.html new file mode 100644 index 0000000..5d10856 --- /dev/null +++ b/docs/reference/buildNetworkUnmappedSourceCodeIndex.html @@ -0,0 +1,100 @@ + +Build Unmapped Source Code Network Index — buildNetworkUnmappedSourceCodeIndex • AresIndexer + + +
    +
    + + + +
    +
    +
    +

    Build Unmapped Source Code Network Index

    + Source: R/BuildNetworkUnmappedSourceCodeIndex.R + +
    + +
    +

    Build Unmapped Source Code Network Index

    +
    + +
    + 
    buildNetworkUnmappedSourceCodeIndex(sourceFolders, outputFolder)
    +
    + +
    +

    Arguments

    +
    sourceFolders
    +

    A vector of data source folders

    + + +
    outputFolder
    +

    Location of the Ares data folder

    + +
    +
    +

    Value

    + + +

    A data frame with a the network unmapped source code index

    +
    +
    +

    Details

    +

    Builds an aggregate index of the unmapped source codes across all source folders.

    +
    + +
    + +
    + + +
    +

    Developed by Frank DeFalco.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/getSourceReleaseKey.html b/docs/reference/getSourceReleaseKey.html new file mode 100644 index 0000000..33c39ed --- /dev/null +++ b/docs/reference/getSourceReleaseKey.html @@ -0,0 +1,80 @@ + +getSourceReleaseKey — getSourceReleaseKey • AresIndexer + + +
    +
    + + + +
    +
    +
    +

    getSourceReleaseKey

    + Source: R/GetSourceReleaseKey.R + +
    + +
    +

    Returns the source release key for this CDM database for use within ARES

    +
    + +
    + 
    getSourceReleaseKey(connectionDetails, cdmDatabaseSchema)
    +
    + + +
    + +
    + + +
    +

    Developed by Frank DeFalco.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000..22fc846 --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,110 @@ + +Function reference • AresIndexer + + +
    +
    + + + +
    +
    +
    +

    Reference

    +
    + + + + + + + + + + + + + + + + + + + + +
    +

    All functions

    +

    +
    +

    augmentConceptFiles()

    +

    Augment Concept Files

    +

    buildDataQualityHistoryIndex()

    +

    Data Quality Historical Indexing

    +

    buildDataQualityIndex()

    +

    Build the Data Quality Index

    +

    buildDataSourceHistoryIndex()

    +

    Data Quality Historical Indexing

    +

    buildExportQueryIndex

    +

    Export Query Details

    +

    buildNetworkIndex()

    +

    Build Network Index

    +

    buildNetworkPerformanceIndex

    +

    Build Network Performance Index

    +

    buildNetworkUnmappedSourceCodeIndex()

    +

    Build Unmapped Source Code Network Index

    +

    getSourceReleaseKey()

    +

    getSourceReleaseKey

    + + +
    + + +
    +

    Developed by Frank DeFalco.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml new file mode 100644 index 0000000..8c8d243 --- /dev/null +++ b/docs/sitemap.xml @@ -0,0 +1,45 @@ + + + + /404.html + + + /authors.html + + + /index.html + + + /LICENSE-text.html + + + /reference/augmentConceptFiles.html + + + /reference/buildDataQualityHistoryIndex.html + + + /reference/buildDataQualityIndex.html + + + /reference/buildDataSourceHistoryIndex.html + + + /reference/buildExportQueryIndex.html + + + /reference/buildNetworkIndex.html + + + /reference/buildNetworkPerformanceIndex.html + + + /reference/buildNetworkUnmappedSourceCodeIndex.html + + + /reference/getSourceReleaseKey.html + + + /reference/index.html + + diff --git a/extras/PackageMaintenance.R b/extras/PackageMaintenance.R new file mode 100644 index 0000000..e69de29 diff --git a/man/augmentConceptFiles.Rd b/man/augmentConceptFiles.Rd new file mode 100644 index 0000000..7b67d45 --- /dev/null +++ b/man/augmentConceptFiles.Rd @@ -0,0 +1,17 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/AugmentConceptFiles.R +\name{augmentConceptFiles} +\alias{augmentConceptFiles} +\title{Augment Concept Files} +\usage{ +augmentConceptFiles(releaseFolder) +} +\arguments{ +\item{releaseFolder}{Folder containing a specific release of a data source} +} +\description{ +Augment Concept Files +} +\details{ +Adds Data Quality and Temporal details to concept data files +} diff --git a/man/buildDataQualityIndex.Rd b/man/buildDataQualityIndex.Rd new file mode 100644 index 0000000..054e87f --- /dev/null +++ b/man/buildDataQualityIndex.Rd @@ -0,0 +1,23 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/BuildDataQualityIndex.R +\name{buildDataQualityIndex} +\alias{buildDataQualityIndex} +\title{Build the Data Quality Index} +\usage{ +buildDataQualityIndex(sourceFolders, outputFolder) +} +\arguments{ +\item{sourceFolders}{A vector of folder locations that contain the dq-result.json files +to be included in the network data quality index.} + +\item{outputFolder}{Location of the Ares data folder} +} +\value{ +A data frame with a the necessary network data quality data +} +\description{ +Build the Data Quality Index +} +\details{ +Creates a data quality stratified network index +} diff --git a/man/buildExportQueryIndex.Rd b/man/buildExportQueryIndex.Rd new file mode 100644 index 0000000..23ca226 --- /dev/null +++ b/man/buildExportQueryIndex.Rd @@ -0,0 +1,14 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/BuildExportQueryIndex.R +\name{buildExportQueryIndex} +\alias{buildExportQueryIndex} +\title{Export Query Details} +\arguments{ +\item{outputFolder}{Path to source folder} +} +\description{ +Export Query Details +} +\details{ +Exports a query index that contains links to the queries used to generate all data summaries. +} diff --git a/man/buildNetworkIndex.Rd b/man/buildNetworkIndex.Rd new file mode 100644 index 0000000..e9df4a4 --- /dev/null +++ b/man/buildNetworkIndex.Rd @@ -0,0 +1,24 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/BuildNetworkIndex.R +\name{buildNetworkIndex} +\alias{buildNetworkIndex} +\title{Build Network Index} +\usage{ +buildNetworkIndex(sourceFolders, outputFolder) +} +\arguments{ +\item{sourceFolders}{A vector of folder locations that contain the files +exported from Achilles in the ARES Option format (Achilles::exportAO) +to be included in the network data quality index.} + +\item{outputFolder}{The location of the Ares data folder.} +} +\value{ +The JSON object that is written to the ARES data folder (outputFolder parameter). +} +\description{ +Build Network Index +} +\details{ +Generates a network index containing data source history across releases including performance, and data quality metrics. +} diff --git a/man/buildNetworkPerformanceIndex.Rd b/man/buildNetworkPerformanceIndex.Rd new file mode 100644 index 0000000..622196b --- /dev/null +++ b/man/buildNetworkPerformanceIndex.Rd @@ -0,0 +1,17 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/BuildNetworkPerformanceIndex.R +\name{buildNetworkPerformanceIndex} +\alias{buildNetworkPerformanceIndex} +\title{Build Network Performance Index} +\arguments{ +\item{sourceFolder}{Path to source folder} +} +\value{ +Network performance results object. +} +\description{ +Build Network Performance Index +} +\details{ +Builds an index with network performance results for Achilles and DQD execution across all source folders. +} diff --git a/man/buildNetworkUnmappedSourceCodeIndex.Rd b/man/buildNetworkUnmappedSourceCodeIndex.Rd new file mode 100644 index 0000000..85fedf4 --- /dev/null +++ b/man/buildNetworkUnmappedSourceCodeIndex.Rd @@ -0,0 +1,22 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/BuildNetworkUnmappedSourceCodeIndex.R +\name{buildNetworkUnmappedSourceCodeIndex} +\alias{buildNetworkUnmappedSourceCodeIndex} +\title{Build Unmapped Source Code Network Index} +\usage{ +buildNetworkUnmappedSourceCodeIndex(sourceFolders, outputFolder) +} +\arguments{ +\item{sourceFolders}{A vector of data source folders} + +\item{outputFolder}{Location of the Ares data folder} +} +\value{ +A data frame with a the network unmapped source code index +} +\description{ +Build Unmapped Source Code Network Index +} +\details{ +Builds an aggregate index of the unmapped source codes across all source folders. +}