Update readme, address check errors (#50)

README.Rmd

@@ -17,22 +17,32 @@ knitr::opts_chunk$set(
 
 <!-- badges: start -->
 
-[![test-coverage](https://github.com/Spatiotemporal-Exposures-and-Toxicology/GeoTox/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/Spatiotemporal-Exposures-and-Toxicology/GeoTox/actions/workflows/test-coverage.yaml)
-[![codecov](https://codecov.io/github/Spatiotemporal-Exposures-and-Toxicology/GeoTox/graph/badge.svg?token=I1L9BZJ58Y)](https://codecov.io/github/Spatiotemporal-Exposures-and-Toxicology/GeoTox)
-[![R-CMD-check](https://github.com/Spatiotemporal-Exposures-and-Toxicology/GeoTox/actions/workflows/check-release.yaml/badge.svg)](https://github.com/Spatiotemporal-Exposures-and-Toxicology/GeoTox/actions/workflows/check-release.yaml)
-[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![CRAN status](https://www.r-pkg.org/badges/version/GeoTox)](https://CRAN.R-project.org/package=GeoTox)
+[![R-CMD-check](https://github.com/NIEHS/GeoTox/actions/workflows/check-release.yaml/badge.svg)](https://github.com/NIEHS/GeoTox/actions/workflows/check-release.yaml)
+[![cov](https://NIEHS.github.io/GeoTox/badges/coverage.svg)](https://github.com/NIEHS/GeoTox/actions)
+[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+[![CRAN status](https://www.r-pkg.org/badges/version/GeoTox)](https://CRAN.R-project.org/package=GeoTox)
 
 <!-- badges: end -->
 
-![](https://codecov.io/github/Spatiotemporal-Exposures-and-Toxicology/GeoTox/graphs/icicle.svg?token=I1L9BZJ58Y)
-
-The GeoTox package can <x y z plus other stuff>, as introduced in [Eccles KM, Karmaus AL, Kleinstreuer NC, Parham F, Rider CV, Wambaugh JF, Messier KP. A geospatial modeling approach to quantifying the risk of exposure to environmental chemical mixtures via a common molecular target. Sci Total Environ. 2023 Jan 10;855:158905. doi: 10.1016/j.scitotenv.2022.158905. Epub 2022 Sep 21. PMID: 36152849; PMCID: PMC9979101.](https://pubmed.ncbi.nlm.nih.gov/36152849/)
+[Eccles KM, Karmaus AL, Kleinstreuer NC, Parham F, Rider CV, Wambaugh JF, Messier KP. A geospatial modeling approach to quantifying the risk of exposure to environmental chemical mixtures via a common molecular target. Sci Total Environ. 2023 Jan 10;855:158905. doi: 10.1016/j.scitotenv.2022.158905. Epub 2022 Sep 21. PMID: 36152849; PMCID: PMC9979101.](https://pubmed.ncbi.nlm.nih.gov/36152849/)
 
 ## Installation
 
-You can install the development version of GeoTox from [GitHub](https://github.com/) with:
+You can install the development version of GeoTox from
+[GitHub](https://github.com/) with:
 
-``` r
-# install.packages("pak")
+```{r, eval=FALSE}
+# Without vignettes
+if (!require("pak", quietly = TRUE)) {
+  install.packages("pak")
+}
 pak::pkg_install("NIEHS/GeoTox")
+
+# With vignettes
+if (!require("remotes", quietly = TRUE)) {
+  install.packages("remotes")
+}
+remotes::install_github("NIEHS/GeoTox",
+                        dependencies = TRUE,
+                        build_vignettes = TRUE)
 ```

README.md

@@ -4,17 +4,17 @@
 # GeoTox
 
 <!-- badges: start -->
+
 [![R-CMD-check](https://github.com/NIEHS/GeoTox/actions/workflows/check-release.yaml/badge.svg)](https://github.com/NIEHS/GeoTox/actions/workflows/check-release.yaml)
 [![cov](https://NIEHS.github.io/GeoTox/badges/coverage.svg)](https://github.com/NIEHS/GeoTox/actions)
-[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+[![Project Status: WIP – Initial development is in progress, but there
+has not yet been a stable, usable release suitable for the
+public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
 [![CRAN
 status](https://www.r-pkg.org/badges/version/GeoTox)](https://CRAN.R-project.org/package=GeoTox)
 
 <!-- badges: end -->
 
-![](https://codecov.io/github/Spatiotemporal-Exposures-and-Toxicology/GeoTox/graphs/icicle.svg?token=I1L9BZJ58Y)
-
-
 [Eccles KM, Karmaus AL, Kleinstreuer NC, Parham F, Rider CV, Wambaugh
 JF, Messier KP. A geospatial modeling approach to quantifying the risk
 of exposure to environmental chemical mixtures via a common molecular
@@ -28,9 +28,17 @@ You can install the development version of GeoTox from
 [GitHub](https://github.com/) with:
 
 ``` r
-# install.packages("devtools")
-
-# alternatively
-# install.packages("pak")
+# Without vignettes
+if (!require("pak", quietly = TRUE)) {
+  install.packages("pak")
+}
 pak::pkg_install("NIEHS/GeoTox")
+
+# With vignettes
+if (!require("remotes", quietly = TRUE)) {
+  install.packages("remotes")
+}
+remotes::install_github("NIEHS/GeoTox",
+                        dependencies = TRUE,
+                        build_vignettes = TRUE)
 ```