From 67695c172a25d70049b285958c63aa31c6303830 Mon Sep 17 00:00:00 2001 From: "Zhian N. Kamvar" Date: Sun, 6 Jun 2021 18:34:02 -0700 Subject: [PATCH 1/3] add the universe --- README.md | 46 +++++++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index e399a302..58f6acc5 100644 --- a/README.md +++ b/README.md @@ -94,41 +94,45 @@ github below. ### Stable and Development versions -To install this package from github, make sure you have the following: - -- [Xcode](https://developer.apple.com/xcode/) (OSX) - OR [Rtools](https://cran.r-project.org/bin/windows/Rtools/) (Windows) -- [{remotes}](https://github.com/r-lib/remotes) (to install, use: `install.packages("remotes")`) - -For Linux users, make sure that the function `getOption("unzip")` returns -`"unzip"` or `"internal"`. If it doesn't, then run `options(unzip = -"internal")`. - -Once you have {remotes} and a C compiler installed, you can use the -`install_github()` function to install the current version from github. #### Stable version This release will contain bug fixes and new, documented, and stable features -that will be included in future releases. Note: if you don't have LaTeX -installed, you should set `build_vignettes = FALSE`. - -> Note: As of 2020-06-12 the default branch is the "main" branch to avoid the -> "master/slave" terminology. For reference, see the -> [IETF draft memo](https://tools.ietf.org/id/draft-knodel-terminology-00.html#rfc.section.1.1.1). +that will be included in future releases. These stable versions are built hourly +at and you can install it with: ```R -remotes::install_github(repo = "grunwaldlab/poppr@main", build_vignettes = TRUE) -library("poppr") +universe <- c("https://zkamvar.r-universe.dev", "https://cloud.rproject.org") +install.packages("poppr", repos = universe) ``` +The universe repository also contain up-to-date versions of {adegenet} and +{hierfstat}, which are commonly used in conjunction with {poppr} and are +notoriously out of date on CRAN. + #### Unstable/Development versions +All Development versions of {poppr} will be on GitHub, but need to be compiled. + +To install this package from github, make sure you have the following: + +- [Xcode](https://developer.apple.com/xcode/) (OSX) + OR [Rtools](https://cran.r-project.org/bin/windows/Rtools/) (Windows) +- [{remotes}](https://github.com/r-lib/remotes) (to install, use: `install.packages("remotes")`) + +> For Linux users, make sure that the function `getOption("unzip")` returns +> `"unzip"` or `"internal"`. If it does not, then run `options(unzip = +> "internal")`. + +Once you have {remotes} and a C compiler installed, you can use the +`install_github()` function to install the current version from github. + All new features in testing will be released on different branches. These features will be in various stages of development and may or may not be documented. Install with caution. The below command would install features on the branch called "devel". Note that these branches might be out of date -from the main branch. +from the main branch. Note: if you don't have LaTeX installed, you should set +`build_vignettes = FALSE`. ```R remotes::install_github(repo = "grunwaldlab/poppr@devel", build_vignettes = TRUE) From 51ab1be3c22013dbd10ad34f9ad0372a46209bd2 Mon Sep 17 00:00:00 2001 From: "Zhian N. Kamvar" Date: Sun, 6 Jun 2021 18:35:25 -0700 Subject: [PATCH 2/3] use correct URL --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 58f6acc5..cb077d9c 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ that will be included in future releases. These stable versions are built hourly at and you can install it with: ```R -universe <- c("https://zkamvar.r-universe.dev", "https://cloud.rproject.org") +universe <- c("https://zkamvar.r-universe.dev", "https://cloud.r-project.org") install.packages("poppr", repos = universe) ``` From 3841ce54efd7b511d437e137b391d3063674d5f4 Mon Sep 17 00:00:00 2001 From: "Zhian N. Kamvar" Date: Sun, 6 Jun 2021 18:40:11 -0700 Subject: [PATCH 3/3] clean up language --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index cb077d9c..51455bbf 100644 --- a/README.md +++ b/README.md @@ -87,19 +87,20 @@ To install, make sure R is at least version 2.15.1 (the authors recommend ≥ install.packages("poppr") ``` -If you want the absolute latest version of *poppr*, see about installing from -github below. +If you want the absolute latest version of *poppr*, see about installing +unreleased versions below. *** -### Stable and Development versions +### Stable version +New features are occasionally added to {poppr}, but it can take time for it to +get to CRAN. If you know that you want the latest version of {poppr}, (which +will contain bug fixes and new features to be included in future releases), then +you can use the custom R-Universe repository, which is updated hourly: + -#### Stable version - -This release will contain bug fixes and new, documented, and stable features -that will be included in future releases. These stable versions are built hourly -at and you can install it with: +To install poppr from the R-Universe, you can use the following code: ```R universe <- c("https://zkamvar.r-universe.dev", "https://cloud.r-project.org") @@ -110,7 +111,7 @@ The universe repository also contain up-to-date versions of {adegenet} and {hierfstat}, which are commonly used in conjunction with {poppr} and are notoriously out of date on CRAN. -#### Unstable/Development versions +### Unstable/Development versions All Development versions of {poppr} will be on GitHub, but need to be compiled.