Skip to content

Commit

Permalink
Merge pull request #16 from MindTheGap-ERC/cleanup
Browse files Browse the repository at this point in the history
Cleanup
  • Loading branch information
NiklasHohmann authored Jan 18, 2024
2 parents 28ddd12 + eddad34 commit d3073bc
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 13 deletions.
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
Depends:
R (>= 2.10)
R (>= 2.10),
ape
LazyData: true
Suggests:
ape,
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,7 @@ Orcid: [0000-0003-1559-1838](https://orcid.org/0000-0003-1559-1838)

## Installation

To install the package from _CRAN_, run

```R
install.packages("admtools")
```

in R. To install the package from _GitHub_, first install the _remotes_ package
To install the package from _GitHub_, first install the _remotes_ package

```R
install.packages("remotes")
Expand All @@ -33,11 +27,17 @@ Then, run
```R
remotes::install_github(repo = "MindTheGap-ERC/admtools",
build_vignettes = TRUE,
ref = "v0.1.0")
ref = "HEAD",
dependencies = TRUE)
```

To install the version under development, use `ref = "HEAD"` instead.
You can also install the package from _CRAN_. For this, run

```R
install.packages("admtools")
```

in R.
After installation, you can load the package using

```R
Expand All @@ -52,7 +52,7 @@ browseVignettes(package = "admtools") # opens in Browser
vignette(package = "admtools")
```

A good place to start reading is the introductionary vignette, availble via
A good place to start reading is the introductionary vignette, available via

```R
vignette("admtools")
Expand Down
5 changes: 3 additions & 2 deletions vignettes/admtools.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,11 @@ Then run
```{r, eval=FALSE}
remotes::install_github(repo = "MindTheGap-ERC/admtools",
build_vignettes = TRUE,
ref = "v0.1.0")
ref = "HEAD",
dependencies = TRUE)
```

to install the latest release. To install the version in development, use `ref = "HEAD"` instead.
to install the latest version.

### From CRAN

Expand Down

0 comments on commit d3073bc

Please sign in to comment.