[GEN-1109] Setup base mkdocs for genie

.github/workflows/build_docs.yml

@@ -0,0 +1,36 @@
+name: Build Github Pages Docs
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Cache dependences
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          # Unique cache key based on requirements.txt in docs directory
+          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}-mkdocs-deps 
+          # Restore partial cache if exact match is not found
+          restore-keys: |
+            ${{ runner.os }}-pip-  
+
+      - name: Install mkdocs and dependencies
+        run: |
+            pip install mkdocs mkdocs-material mkdocstrings mkdocstrings-python mkdocs-open-in-new-tab
+
+      - name: Build and deploy mkdocs site to GitHub Pages
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: mkdocs gh-deploy --force

.gitignore

@@ -26,3 +26,6 @@ data_guide.out
 Genie.Rproj
 build/
 dist/
+
+# MkDocs output
+docs_site/

README.md

@@ -6,11 +6,14 @@
 [![Docker Automated](https://img.shields.io/docker/automated/sagebionetworks/genie.svg?style=for-the-badge&logo=docker)](https://hub.docker.com/r/sagebionetworks/genie)
 [![GitHub CI](https://img.shields.io/github/actions/workflow/status/Sage-Bionetworks/Genie/ci.yml?branch=develop&style=for-the-badge&logo=github)](https://github.com/Sage-Bionetworks/Genie)
 
-
 ## Introduction
 
 This repository documents code used to gather, QC, standardize, and analyze data uploaded by institutes participating in AACR's Project GENIE (Genomics, Evidence, Neoplasia, Information, Exchange).
 
+## Documentation
+
+For more information about the AACR genie repository, [visit the GitHub Pages site.](https://sage-bionetworks.github.io/Genie/)
+
 ## Dependencies
 
 This package contains both R, Python and cli tools.  These are tools or packages you will need, to be able to reproduce these results:

docs/getting_started.md

@@ -0,0 +1,74 @@
+# Getting Started
+
+## Dependencies
+
+This package contains both R, Python and cli tools.  These are tools or packages you will need, to be able to reproduce these results:
+
+- Python >=3.8 or <3.10
+    - `pip install -r requirements.txt`
+- [bedtools](https://bedtools.readthedocs.io/en/latest/content/installation.html)
+- R 4.2.2
+    - `renv::install()`
+    - Follow instructions [here](https://r-docs.synapse.org/#note-for-windows-and-mac-users) to install synapser
+- [Java > 8](https://www.java.com/en/download/)
+    - For mac users, it seems to work better to run `brew install java`
+- [wget](https://www.gnu.org/software/wget/)
+    - For mac users, have to run `brew install wget`
+
+## Installation
+
+### PyPi
+
+The [aacrgenie](https://pypi.org/project/aacrgenie/) package is available from PyPI. It can be installed or upgraded with pip.
+
+```
+pip install aacrgenie
+```
+
+### Local
+
+Source code and development versions are available on Github. Installing from source:
+
+```
+git clone https://github.com/Sage-Bionetworks/Genie.git
+cd Genie
+```
+
+Install the packages locally.
+
+```
+pip install -e .
+pip install -r requirements.txt
+pip install -r requirements-dev.txt
+```
+
+You can stay on the main branch to get the latest stable release or check out the develop branch or a tagged revision:
+
+```
+git checkout <branch or tag>
+```
+
+
+## Configuration
+
+Configure the Synapse client to authenticate to Synapse.
+
+1. Create a Synapse [Personal Access token (PAT)](https://help.synapse.org/docs/Managing-Your-Account.2055405596.html#ManagingYourAccount-PersonalAccessTokens).
+1. Add a `~/.synapseConfig` file with the following information:
+
+    ```
+    [authentication]
+    authtoken = <PAT here>
+    ```
+
+1. OR set an environmental variable
+
+    ```
+    export SYNAPSE_AUTH_TOKEN=<PAT here>
+    ```
+
+1. Confirm you can log in to synapse in your terminal.
+
+    ```shell
+    synapse login
+    ```

docs/index.md

@@ -0,0 +1,15 @@
+![genie banner](https://raw.githubusercontent.com/Sage-Bionetworks/Genie/master/genie_banner.png)
+
+# AACR Project GENIE
+
+[![PyPi](https://img.shields.io/pypi/v/aacrgenie.svg?style=for-the-badge&label=PyPi&logo=PyPi)](https://pypi.org/project/aacrgenie)
+[![Docker Automated](https://img.shields.io/docker/automated/sagebionetworks/genie.svg?style=for-the-badge&logo=docker)](https://hub.docker.com/r/sagebionetworks/genie)
+[![GitHub CI](https://img.shields.io/github/actions/workflow/status/Sage-Bionetworks/Genie/ci.yml?branch=develop&style=for-the-badge&logo=github)](https://github.com/Sage-Bionetworks/Genie)
+
+## Introduction
+
+This repository documents code used to gather, QC, standardize, and analyze data uploaded by institutes participating in AACR's Project GENIE (Genomics, Evidence, Neoplasia, Information, Exchange).
+
+## Additional Documentation
+
+Visit the [Project Genie Data Portal](https://genie.synapse.org/) to learn more about our data

docs/reference/fileformats/assay.md

@@ -0,0 +1 @@
+::: genie_registry.assay

docs/reference/fileformats/bed.md

@@ -0,0 +1 @@
+::: genie_registry.bed

docs/reference/fileformats/clinical.md

@@ -0,0 +1 @@
+::: genie_registry.clinical

docs/reference/fileformats/cna.md

@@ -0,0 +1 @@
+::: genie_registry.cna

docs/reference/fileformats/fileformat.md

@@ -0,0 +1 @@
+::: genie.example_filetype_format

docs/reference/fileformats/maf.md

@@ -0,0 +1 @@
+::: genie_registry.maf

docs/reference/fileformats/mutations_in_cis.md

@@ -0,0 +1 @@
+::: genie_registry.mutationsInCis

docs/reference/fileformats/patient_retraction.md

@@ -0,0 +1 @@
+::: genie_registry.patientRetraction

docs/reference/fileformats/sample_retraction.md

@@ -0,0 +1 @@
+::: genie_registry.sampleRetraction

docs/reference/fileformats/seg.md

@@ -0,0 +1 @@
+::: genie_registry.seg

docs/reference/fileformats/structural_variant.md

@@ -0,0 +1 @@
+::: genie_registry.structural_variant

docs/reference/fileformats/vcf.md

@@ -0,0 +1 @@
+::: genie_registry.vcf

docs/reference/fileformats/workflow.md

@@ -0,0 +1 @@
+::: genie_registry.workflow

docs/reference/helper_modules/create_case_lists.md

@@ -0,0 +1 @@
+::: genie.create_case_lists

docs/reference/helper_modules/dashboard_table_updater.md

@@ -0,0 +1 @@
+::: genie.dashboard_table_updater

docs/reference/helper_modules/extract.md

@@ -0,0 +1 @@
+::: genie.extract

docs/reference/helper_modules/load.md

@@ -0,0 +1 @@
+::: genie.load

docs/reference/helper_modules/process_functions.md

@@ -0,0 +1 @@
+::: genie.process_functions

docs/reference/helper_modules/transform.md

@@ -0,0 +1 @@
+::: genie.transform

docs/reference/helper_modules/validate.md

@@ -0,0 +1 @@
+::: genie.validate

docs/reference/main_pipeline_commands/consortium_to_public.md

@@ -0,0 +1 @@
+::: bin.consortium_to_public

docs/reference/main_pipeline_commands/database_to_staging.md

@@ -0,0 +1 @@
+::: bin.database_to_staging

docs/reference/main_pipeline_commands/input_to_database.md

@@ -0,0 +1 @@
+::: bin.input_to_database

docs/reference/main_pipeline_steps/consortium_to_public.md

@@ -0,0 +1 @@
+::: genie.consortium_to_public

docs/reference/main_pipeline_steps/database_to_staging.md

@@ -0,0 +1 @@
+::: genie.database_to_staging

docs/reference/main_pipeline_steps/input_to_database/input_to_database.md

@@ -0,0 +1 @@
+::: genie.input_to_database

docs/reference/main_pipeline_steps/input_to_database/process_mutation.md

@@ -0,0 +1 @@
+::: genie.process_mutation

docs/reference/main_pipeline_steps/input_to_database/to_retract.md

@@ -0,0 +1 @@
+::: genie.toRetract

docs/reference/main_pipeline_steps/input_to_database/write_invalid_reasons.md

@@ -0,0 +1 @@
+::: genie.write_invalid_reasons

docs/requirements.txt

@@ -0,0 +1,5 @@
+mkdocs<=1.6.0
+mkdocs-material<=9.5.23
+mkdocs-open-in-new-tab<=1.0.3
+mkdocstrings<=0.25.1
+mkdocstrings-python<=1.10.2

docs/tutorials/local_file_validation.md

@@ -0,0 +1,20 @@
+# Local File Validation
+
+One of the features of the `aacrgenie` package is that is provides a local validation tool that GENIE data contributors and install and use to validate their files locally prior to uploading to Synapse.
+
+```
+pip install aacrgenie
+genie -v
+```
+
+This will install all the necessary components for you to run the validator locally on all of your files, including the Synapse client.  Please view the help to see how to run to validator.
+
+```
+genie validate -h
+```
+
+Validate a file
+
+```
+genie validate data_clinical_supp_SAGE.txt SAGE
+```