diff --git a/pcgrr/vignettes/installation.Rmd b/pcgrr/vignettes/installation.Rmd index 6b8ea936..b5d27bab 100644 --- a/pcgrr/vignettes/installation.Rmd +++ b/pcgrr/vignettes/installation.Rmd @@ -110,17 +110,16 @@ See the [Inputs](input.html) article. ## Software -The PCGR workflow can be installed using: +The PCGR workflow can be installed with any of the following: -- A. [Conda][conda-web]. -- B. [Docker][docker-web], -- C. [Singularity/Apptainer][apptainer-web], or +- A. [Conda][conda-web], +- B. [Docker][docker-web], or +- C. [Singularity/Apptainer][apptainer-web]. [conda-web]: https://conda.io/projects/conda/en/latest/user-guide/getting-started.html [docker-web]: https://docs.docker.com/ [apptainer-web]: https://apptainer.org/docs/user/latest/index.html - ### A. Conda {.tabset .tabset-pills} There is Conda support for both Linux and macOS machines. @@ -176,7 +175,6 @@ pcgr --version pcgr --help ``` - ### B. Docker The PCGR Docker image is available on [Docker Hub](https://hub.docker.com/r/sigven/pcgr/tags). @@ -219,7 +217,7 @@ docker container run -it --rm \ The PCGR Singularity/Apptainer image is available on [GitHub Container Registry](https://ghcr.io/sigven/pcgr). Pull the latest **v`r PCGR_VERSION`** image with: -```{r} +```{r echo=FALSE} glue("apptainer pull oras://ghcr.io/sigven/pcgr:{PCGR_VERSION}.singularity") ``` @@ -233,7 +231,6 @@ echo "PCGR_VERSION=\"${PCGR_VERSION}\"" ``` ```bash -# let's assume you have all data sitting in ~/projects/proj1/pcgr_inputs and ~/projects/proj1/ apptainer exec \ --writable-tmpfs \ --no-home \ @@ -256,6 +253,6 @@ apptainer exec \ --vcf2maf ``` -If you run into issues or problems related to apptainer/singularity, we appreciate if you can try to -resolve them directly through the apptainer community. The authors of PCGR/CPSR have limited experience with apptainer, and we thus cannot offer extensive feedback on issues related to such matters. - +**Note**: For any Apptainer/Singularity issues not directly related to PCGR, we +would recommend reaching out to the Apptainer community (e.g. https://github.com/apptainer/apptainer) +since we have limited experience with Apptainer/Singularity. diff --git a/pcgrr/vignettes/running.Rmd b/pcgrr/vignettes/running.Rmd index 269e9bb6..bed9cb36 100644 --- a/pcgrr/vignettes/running.Rmd +++ b/pcgrr/vignettes/running.Rmd @@ -19,7 +19,7 @@ By default, PCGR expects that the input VCF comes from whole-exome sequencing. T * `--effective_target_size_mb ` -Ideally, this should reflect the _callable_ target size of the assay, i.e. the size of the target regions for which coding variants is sufficiently covered (i.e. with a certain sequencing depth) by the sequencing assay. This can be estimated by the user based on the design of the sequencing assay, or by using tools such as [mosdepth](). +Ideally, this should reflect the _callable_ target size of the assay, i.e. the size of the target regions for which coding variants is sufficiently covered (i.e. with a certain sequencing depth) by the sequencing assay. This can be estimated by the user based on the design of the sequencing assay, or by using tools such as [mosdepth](https://github.com/brentp/mosdepth). ### Tumor-control vs. tumor-only