achilles.md

+# Installation
+## R package
+
+Achilles is a R package available [here](https://github.com/OHDSI/Achilles).
+To install Achilles package, you need to use `devtools::install_github()` function.
+
+```r
+devtools::install_github("OHDSI/Achilles")
+```
+## SQL results tables
+
+The output table of the Achilles statistic computation need to be created before run Achilles analysis:
+- ACHILLES_RESULTS
+- ACHILLES_HEEL
+- ACHILLES_RESULTS_CONCEPT_COUNT
+- ACHILLES_RESULTS_DIST
+
+The scripts are available bellow. They must be run in the OMOP result scheme.
+
+```sql
+CREATE TABLE ACHILLES_RESULTS
+(
+  ANALYSIS_ID NUMBER(38)
+  , STRATUM_1 VARCHAR2(255)
+  , STRATUM_2 VARCHAR2(255)
+  , STRATUM_3 VARCHAR2(255)
+  , STRATUM_4 VARCHAR2(255)
+  , STRATUM_5 VARCHAR2(255)
+  , COUNT_VALUE NUMBER(38)
+);
+```
+
+```sql
+CREATE TABLE ACHILLES_HEEL
+(
+  ANALYSIS_ID NUMBER(38)
+  , ACHILLES_HEEL_WARNING VARCHAR2(255)
+  , RULE_ID NUMBER(38)
+  , RECORD_COUNT NUMBER(38)
+);
+```
+
+```sql
+CREATE TABLE ACHILLES_RESULTS_CONCEPT_COUNT
+(
+  CONCEPT_ID NUMBER(38)
+  , RECORD_COUNT NUMBER(38)
+  , DESCENDANT_RECORD_COUNT NUMBER(38)
+);
+```
+
+```sql
+CREATE TABLE ACHILLES_RESULTS_DIST
+(
+  ANALYSIS_ID NUMBER(38)
+  , STRATUM_1 VARCHAR2(255)
+  , STRATUM_2 VARCHAR2(255)
+  , STRATUM_3 VARCHAR2(255)
+  , STRATUM_4 VARCHAR2(255)
+  , STRATUM_5 VARCHAR2(255)
+  , COUNT_VALUE NUMBER(38)
+  , MIN_VALUE FLOAT
+  , MAX_VALUE FLOAT
+  , AVG_VALUE FLOAT
+  , STDEV_VALUE FLOAT
+  , MEDIAN_VALUE FLOAT
+  , P10_VALUE FLOAT
+  , P25_VALUE FLOAT
+  , P75_VALUE FLOAT
+  , P90_VALUE FLOAT
+);
+```
+
+# Statistic computation
+## Connexion
+
+A connexion to the OMOP database is created by the `Achilles::createConnectionDetails()` function.
+An example of connexion is avalable bellow.
+
+```r
+connectionDetails <- Achilles::createConnectionDetails(
+	dbms = 'oracle',
+	user = '[USER]',
+	password = '[PASSWORD]',
+	connectionString = 'jdbc:oracle:thin:@[SID]:[PORT]:[DBNAME]'
+)
+```
+
+## Analysis
+
+Statistic computation are generated by the `Achilles::achilles()` function.
+
+```r
+Achilles::achilles(
+	connectionDetails = connectionDetails,
+	cdmDatabaseSchema = 'omop',
+	resultsDatabaseSchema = 'omop_temp',
+	vocabDatabaseSchema = 'omop',
+	numThreads = 1,
+	sourceName = 'Achilles',
+	cdmVersion = '5.3.0',
+	runHeel = FALSE,
+	optimizeAtlasCache = TRUE,
+	createTable = FALSE
+)
+```