Skip to content

Commit

Permalink
Clarified usethis makes blank scripts and have updated readme so user…
Browse files Browse the repository at this point in the history
…s will install the correct package
  • Loading branch information
cjrace committed Sep 3, 2024
1 parent 8acf6aa commit 22ae2ef
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ For more information see the [roxygen2 documentation on declaring dependencies](

`usethis::use_r(name = <script_name>)`

This will create a new script within the package R/ folder.
This will create a new blank script within the package R/ folder.

## Creating a new function test script

`usethis::use_test(name = <script_name>)`

This will create a new test script within the package testthat/ folder.
This will create a new blank test script within the package testthat/ folder.

## Updating the package version

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ If you are using
project (recommended):

``` r
renv::install("dfe-analytical-services/dfeR")
renv::install("dfe-analytical-services/dfeshiny")
```

Otherwise:

``` r
# install.packages("devtools")
devtools::install_github("dfe-analytical-services/dfeR")
devtools::install_github("dfe-analytical-services/dfeshiny")
```

## Installing functionality in development from a branch
Expand Down

0 comments on commit 22ae2ef

Please sign in to comment.