Skip to content

Commit

Permalink
notes on installations
Browse files Browse the repository at this point in the history
  • Loading branch information
topepo committed Jan 16, 2021
1 parent 0e6d40f commit d377f86
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
10 changes: 8 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,17 @@ To install the package:
install.packages("embed")
```

Note that, to use some steps, you will also have to load other packages such as `rstanarm` and `lme4`. For all of the steps to work, you may want to use:

```r
install.packages(c("rpart", "xgboost", "rstanarm", "lme4"))
```

To get a bug fix or to use a feature from the development version, you can install the development version of this package from GitHub.

```r
# install.packages("devtools")
devtools::install_github("tidymodels/embed")
# install.packages("remotes")
remotes::install_github("tidymodels/embed")
```


Expand Down
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,20 @@ To install the package:
install.packages("embed")
```

Note that, to use some steps, you will also have to load other packages
such as `rstanarm` and `lme4`. For all of the steps to work, you may
want to use:

``` r
install.packages(c("rpart", "xgboost", "rstanarm", "lme4"))
```

To get a bug fix or to use a feature from the development version, you
can install the development version of this package from GitHub.

``` r
# install.packages("devtools")
devtools::install_github("tidymodels/embed")
# install.packages("remotes")
remotes::install_github("tidymodels/embed")
```

## Contributing
Expand All @@ -113,8 +121,9 @@ By contributing to this project, you agree to abide by its terms.
issue](https://github.com/tidymodels/embed/issues).

- Either way, learn how to create and share a
[reprex](https://reprex.tidyverse.org/articles/articles/learn-reprex.html) (a minimal, reproducible example),
to clearly communicate about your code.
[reprex](https://reprex.tidyverse.org/articles/articles/learn-reprex.html)
(a minimal, reproducible example), to clearly communicate about your
code.

- Check out further details on [contributing guidelines for tidymodels
packages](https://www.tidymodels.org/contribute/) and [how to get
Expand Down

0 comments on commit d377f86

Please sign in to comment.