Skip to content

Commit e5a00ea

Browse files
committed
polish docs for release
1 parent 5801a26 commit e5a00ea

File tree

4 files changed

+13
-20
lines changed

4 files changed

+13
-20
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,12 @@ Snapshots of sections in the [quarto](https://quarto.org)-based cancer predispos
1212

1313
## News
1414

15-
- *June 2024*: **2.x.x release**
16-
- New HTML report generation and layout with [quarto](https://quarto.org/)
17-
- Excel output supported
18-
- Updated virtual gene panels (Genomics England PanelApp, Cancer Gene Census)
19-
- Reference data updates, most importantly including
20-
- ClinVar - June 2024
21-
- CIViC - June 2024
22-
- GENCODE - v46
23-
- Software updates - VEP 112
24-
- Extensive code clean-up and re-structuring
15+
- *June 2024*: **2.0.0 release**
16+
- New HTML report generation and layout with [quarto](https://quarto.org/)
17+
- Excel output supported
18+
- Data bundle update
19+
- Singularity/Apptainer support
20+
- [CHANGELOG](http://cpsr.readthedocs.io/en/latest/CHANGELOG.html)
2521

2622
- *November 2022*: **1.0.1 release**
2723
- Added CPSR logo (designed by [Hal Nakken](https://halvetica.net))

pkgdown/index.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,12 @@ Snapshots of sections in the [quarto](https://quarto.org)-based cancer predispos
2424

2525
### News
2626

27-
* *June 2024*: **2.x.x release**
27+
* *June 2024*: **2.0.0 release**
2828
- New HTML report generation and layout with [quarto](https://quarto.org/)
2929
- Excel output supported
30-
- Updated virtual gene panels (Genomics England PanelApp, Cancer Gene Census)
31-
- Reference data updates, most importantly including
32-
- ClinVar - June 2024
33-
- CIViC - June 2024
34-
- GENCODE - v46
35-
- Software updates - VEP 112
36-
- Extensive code clean-up and re-structuring
30+
- Data bundle update
31+
- Singularity/Apptainer support
32+
- [CHANGELOG](http://cpsr.readthedocs.io/en/latest/CHANGELOG.html)
3733

3834
* *November 2022*: **1.0.1 release**
3935
* Added CPSR logo (designed by [Hal Nakken](https://halvetica.net))

vignettes/CHANGELOG.Rmd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ output: rmarkdown::html_document
55

66
## v2.0.0
77

8-
* Date: **2024-06-xx**
8+
* Date: **2024-06-26**
99
* Data updates
1010
* ClinVar
1111
* GWAS catalog
@@ -27,6 +27,7 @@ output: rmarkdown::html_document
2727
- An HTML report with an overview of the contents of the data bundle is shipped with the reference data itself, also available [here (grch38)](https://rpubs.com/sigven/pcgr_refdata).
2828
- Cleaned up code base for reporting and classification
2929
- A multi-sheet Excel workbook output with variant classifications and biomarker findings are provided, suitable e.g. for aggregation of results across samples
30+
- Singularity/Apptainer support
3031
- argument name changes to `cpsr`:
3132
- `--pcgr_dir` is now named `--refdata_dir`
3233
- `--clinvar_ignore_noncancer` is now named `--clinvar_report_noncancer`, meaning that variants found in ClinVar, yet attributed to _non-cancer related_ phenotypes, are now excluded from reporting by default)

vignettes/running.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ usage:
193193

194194
## Example run
195195

196-
The *cpsr* R package comes with a test VCF file (calls from the GRCh37 human genome assembly) that can be used to test the CPSR workflow. Please note that these are artificial germline calls, not originating form an actual patient.
196+
The *cpsr* R package comes with a test VCF file (calls from the GRCh37 human genome assembly) that can be used to test the CPSR workflow. Please note that these are artificial germline calls, not originating from an actual patient.
197197

198198
Report generation with the example VCF, using the [Adult solid tumours cancer susceptibility](https://panelapp.genomicsengland.co.uk/panels/245/) as the virtual gene panel, can be performed through the following command:
199199

0 commit comments

Comments
 (0)