Skip to content
Snippets Groups Projects
Commit d16232ad authored by Fisher, Jason C.'s avatar Fisher, Jason C.
Browse files

tidy README

parent 166e28e0
No related branches found
No related tags found
4 merge requests!82Merge in develop and bump version,!81Add Zingre (2024) data release,!80Add TreinenOthers2024b and rename 2024a,!79Remove duplicated package in DESCRIPTION file
# inlpubs (development version)
# inlpubs 1.2.0
- ...
- Integrate the remaining publications for 2024.
# inlpubs 1.1.3
......
......@@ -35,13 +35,17 @@ To install the current release of the package from [CRAN], you can use the follo
install.packages("inlpubs")
```
To install the development version of the package, you need to clone the repository and build from source, or run the following commands:
To install the package along with its dependencies, which are required to run examples in the package help documentation and build package datasets, run:
```r
install.packages("inlpubs", dependencies = TRUE)
```
To install the development version of the package, you can either clone the repository and build it from source, or run the following commands. Make sure the **remotes** package for R is installed.
```r
if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_gitlab(
repo = "inl/inlpubs@develop",
auth_token = Sys.getenv("GITLAB_PAT"),
host = "code.usgs.gov",
dependencies = TRUE
)
......@@ -56,6 +60,15 @@ library("inlpubs")
help(package = "inlpubs")
```
## Test
The **tinytest** package is used for unit testing.
To run the tests, use the following command:
```r
tinytest::test_package("inlpubs")
```
## Authors
- Jason C. Fisher (ORCID iD [0000-0001-9032-8912])
......
......@@ -34,14 +34,21 @@ following command in R:
install.packages("inlpubs")
```
To install the development version of the package, you need to clone the
repository and build from source, or run the following commands:
To install the package along with its dependencies, which are required
to run examples in the package help documentation and build package
datasets, run:
``` r
install.packages("inlpubs", dependencies = TRUE)
```
To install the development version of the package, you can either clone
the repository and build it from source, or run the following commands.
Make sure the **remotes** package for R is installed.
``` r
if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_gitlab(
repo = "inl/inlpubs@develop",
auth_token = Sys.getenv("GITLAB_PAT"),
host = "code.usgs.gov",
dependencies = TRUE
)
......@@ -57,6 +64,15 @@ library("inlpubs")
help(package = "inlpubs")
```
## Test
The **tinytest** package is used for unit testing. To run the tests, use
the following command:
``` r
tinytest::test_package("inlpubs")
```
## Authors
- Jason C. Fisher (ORCID iD
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment