Skip to content

Commit

Permalink
update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rcannood committed Nov 11, 2024
1 parent 79a0902 commit 7b45b97
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 10 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,16 @@ See the development roadmap for more details (`vignette("development", package =

## Installation

Get started with **{laminr}** by installing the development version directly from GitHub:
Get started with **{laminr}** by installing the package from CRAN:

```r
# install.packages("remotes")
remotes::install_github("laminlabs/laminr")
install.packages("laminr")
```

To include all suggested dependencies for enhanced functionality, use:

```r
remotes::install_github("laminlabs/laminr", dependencies = TRUE)
install.packages("laminr", dependencies = TRUE)
```

This further installs:
Expand Down
8 changes: 2 additions & 6 deletions vignettes/laminr.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,13 @@ Now, let's set up your environment to use **{laminr}**.
1. Install the **{laminr}** package.

```r
# Install the remotes package if needed
if (!requireMethods("remotes", quiety = TRUE)) {
install.packages("remotes")
}
remotes::install_github("laminlabs/laminr")
install.packages("laminr")
```

2. (Optional) Install suggested dependencies.

```r
remotes::install_github("laminlabs/laminr", dependencies = TRUE)
install.packages("laminr", dependencies = TRUE)
```

This includes packages like **{anndata}** for working with
Expand Down

0 comments on commit 7b45b97

Please sign in to comment.