Skip to content

Commit

Permalink
Temporally fix due to pkgdown v1.4 priority change
Browse files Browse the repository at this point in the history
for details see: r-lib/pkgdown#1136

and in addition also improve installation description with kwb.pkgbuild:::use_installation()
  • Loading branch information
mrustl committed Sep 5, 2019
1 parent 58e323f commit 3b4f6fb
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 32 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,27 @@
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/kwb.utils)](http://cran.r-project.org/package=kwb.utils)


**Cite as:** [![DOI](https://zenodo.org/badge/23293/KWB-R/kwb.utils.svg)](https://zenodo.org/badge/latestdoi/23293/KWB-R/kwb.utils)

## Install from GitHub
## Installation

For details on how to install KWB-R packages checkout our [installation tutorial](https://kwb-r.github.io/kwb.pkgbuild/articles/install.html).


```{r eval=FALSE}
if (!require("devtools")) {
install.packages("devtools", repos = "https://cloud.r-project.org")
```r
### Optionally: specify GitHub Personal Access Token (GITHUB_PAT)
### See here why this might be important for you:
### https://kwb-r.github.io/kwb.pkgbuild/articles/install.html#set-your-github_pat

# Sys.setenv(GITHUB_PAT = "mysecret_access_token")

# Install package "remotes" from CRAN
if (! require("remotes")) {
install.packages("remotes", repos = "https://cloud.r-project.org")
}

devtools::install_github(repo = "kwb-r/kwb.utils", dependencies = TRUE)
# Install KWB package 'kwb.utils' from GitHub

remotes::install_github("kwb-r/kwb.utils")
```
65 changes: 38 additions & 27 deletions README.Rmd → index.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,39 @@
---
title: ''
output: html_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```


[![Appveyor build status](https://ci.appveyor.com/api/projects/status/t9w8xyoyyg7tbk2y/branch/master?svg=true)](https://ci.appveyor.com/project/KWB-R/kwb-utils/branch/master)
[![Build Status](https://travis-ci.org/KWB-R/kwb.utils.svg?branch=master)](https://travis-ci.org/KWB-R/kwb.utils)
[![codecov](https://codecov.io/github/KWB-R/kwb.utils/branch/master/graphs/badge.svg)](https://codecov.io/github/KWB-R/kwb.utils)
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/kwb.utils)](http://cran.r-project.org/package=kwb.utils)
[![DOI](https://zenodo.org/badge/23293/KWB-R/kwb.utils.svg)](https://zenodo.org/badge/latestdoi/23293/KWB-R/kwb.utils)


## Install from GitHub

```{r eval=FALSE}
if (! require("devtools")) {
install.packages("devtools", repos = "https://cloud.r-project.org")
}
devtools::install_github(repo = "kwb-r/kwb.utils", dependencies = TRUE)
---
title: ''
output: html_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```


[![Appveyor build status](https://ci.appveyor.com/api/projects/status/t9w8xyoyyg7tbk2y/branch/master?svg=true)](https://ci.appveyor.com/project/KWB-R/kwb-utils/branch/master)
[![Build Status](https://travis-ci.org/KWB-R/kwb.utils.svg?branch=master)](https://travis-ci.org/KWB-R/kwb.utils)
[![codecov](https://codecov.io/github/KWB-R/kwb.utils/branch/master/graphs/badge.svg)](https://codecov.io/github/KWB-R/kwb.utils)
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/kwb.utils)](http://cran.r-project.org/package=kwb.utils)
[![DOI](https://zenodo.org/badge/23293/KWB-R/kwb.utils.svg)](https://zenodo.org/badge/latestdoi/23293/KWB-R/kwb.utils)


## Installation

For details on how to install KWB-R packages checkout our [installation tutorial](https://kwb-r.github.io/kwb.pkgbuild/articles/install.html).


```r
### Optionally: specify GitHub Personal Access Token (GITHUB_PAT)
### See here why this might be important for you:
### https://kwb-r.github.io/kwb.pkgbuild/articles/install.html#set-your-github_pat

# Sys.setenv(GITHUB_PAT = "mysecret_access_token")

# Install package "remotes" from CRAN
if (! require("remotes")) {
install.packages("remotes", repos = "https://cloud.r-project.org")
}

# Install KWB package 'kwb.utils' from GitHub

remotes::install_github("kwb-r/kwb.utils")
```

0 comments on commit 3b4f6fb

Please sign in to comment.