diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..a3fd96b --- /dev/null +++ b/NEWS.md @@ -0,0 +1,3 @@ +# segregatr 0.2.0 + +* Initial CRAN release diff --git a/README.Rmd b/README.Rmd index c053b92..e348097 100644 --- a/README.Rmd +++ b/README.Rmd @@ -22,19 +22,24 @@ The goal of **segregatr** is to provide segregation analysis for clinical varian ## Installation -You can install the development version of **segregatr** from GitHub with: +You can install **segregatr** from CRAN as follows: -``` r -# install.packages("devtools") +```{r, eval = FALSE} +install.packages("segregatr") +``` + +Alternatively, you can obtain the latest development version from GitHub: +```{r, eval = FALSE} devtools::install_github("magnusdv/segregatr") ``` +## Example + +We start by loading **segregatr**: ```{r} library(segregatr) ``` -## Example - The family below shows four brothers, all affected with a rare dominant disease with 90% penetrance and phenocopy rate 1%. The parents have unknown affection status. All four brothers are shown to carry a candidate variant, warranting a segregation analysis. pathogenic variant. ```{r sibex, echo = F, results = F, fig.height = 2.5, fig.width = 3, out.width = "40%"} diff --git a/README.md b/README.md index 4aa06c6..ff118fb 100644 --- a/README.md +++ b/README.md @@ -11,21 +11,28 @@ clinical variant classification. ## Installation -You can install the development version of **segregatr** from GitHub -with: +You can install **segregatr** from CRAN as follows: + +``` r +install.packages("segregatr") +``` + +Alternatively, you can obtain the latest development version from +GitHub: ``` r -# install.packages("devtools") devtools::install_github("magnusdv/segregatr") ``` +## Example + +We start by loading **segregatr**: + ``` r library(segregatr) #> Loading required package: pedtools ``` -## Example - The family below shows four brothers, all affected with a rare dominant disease with 90% penetrance and phenocopy rate 1%. The parents have unknown affection status. All four brothers are shown to carry a