Merge pull request #84 from uab-cgds-worthey/joss_manuscript

Minor updates
uab-cgds-worthey · Jul 17, 2023 · 667b786 · 667b786
2 parents 7fa985c + 3a43fa5
commit 667b786
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 11 deletions.
diff --git a/docs/Changelog.md b/docs/Changelog.md
@@ -12,6 +12,11 @@ YYYY-MM-DD  John Doe
 ```
 ---
 
+2023-07-17  Manavalan Gajapathy
+
+* Minor updates to documentation.
+
+
 2023-07-16  Manavalan Gajapathy
 
 * Updates doc based on users feedback. 

diff --git a/docs/faq.md b/docs/faq.md
@@ -10,3 +10,8 @@ to the next step. If you want to remove the lock (ie. unlock it), add `-e='--unl
 `src/run_quac.py` command. Once that has completed you can run the original command again and the pipeline will pick up
 from it's last state.
 
+## How to view log files?
+
+* If `--cli_cluster_config` was used, logs from the snakemake process are stored in the directory provided using `--log_dir`. Else, logs will be directed to stderr/stdout and not stored in a file.
+* If `--snakemake_cluster_config` was used, logs for the jobs triggered by snakemake workflow are stored in sub-directory `rule_logs/` under the directory provided using `--log_dir`. Else, logs will be directed to stderr/stdout.
+
diff --git a/docs/quac_cli.md b/docs/quac_cli.md
@@ -6,9 +6,10 @@ wrapper/CLI (command line interface) tool `src/run_quac.py`.
 ## Command line interface
 
 ```sh
-$ python src/run_quac.py -h
-usage: run_quac.py [-h] [--project_name] [--projects_path] [--pedigree]
-                   [--quac_watch_config] [--workflow_config]
+$ python src/run_quac.py  -h
+usage: run_quac.py [-h] --project_name PROJECT_NAME --projects_path
+                   PROJECTS_PATH --pedigree PEDIGREE --quac_watch_config
+                   QUAC_WATCH_CONFIG [--workflow_config]
                    [--snakemake_cluster_config] [--outdir] [--tmp_dir]
                    [--exome] [--include_prior_qc] [--allow_sample_renaming]
                    [-e] [-n] [--cli_cluster_config] [--log_dir]
@@ -18,15 +19,19 @@ Command line interface to QuaC pipeline.
 optional arguments:
   -h, --help            show this help message and exit
 
-QuaC workflow options:
-  --project_name        Project name (default: None)
-  --projects_path       Path where all projects are hosted. Do not include
-                        project name here. (default: None)
-  --pedigree            Pedigree filepath. Must correspond to the project
-                        supplied via --project_name (default: None)
-  --quac_watch_config   YAML config path specifying QC thresholds for QuaC-
+QuaC snakemake workflow options:
+  --project_name PROJECT_NAME
+                        Project name. Required. (default: None)
+  --projects_path PROJECTS_PATH
+                        Path where all projects are hosted. Do not include
+                        project name here. Required. (default: None)
+  --pedigree PEDIGREE   Pedigree filepath. Must correspond to the project
+                        supplied via --project_name. Required. (default: None)
+  --quac_watch_config QUAC_WATCH_CONFIG
+                        YAML config path specifying QC thresholds for QuaC-
                         Watch. See directory 'configs/quac_watch/' in quac
-                        repo for the included config files. (default: None)
+                        repo for the included config files. Required.
+                        (default: None)
   --workflow_config     YAML config path specifying filepath to dependencies
                         of QC tools used in snakemake workflow (default:
                         configs/workflow.yaml)