diff --git a/.Rbuildignore b/.Rbuildignore index c6f21874..4b15cb68 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -11,3 +11,5 @@ README.Rmd ^cran-comments\.md$ ^CRAN-RELEASE$ ^revdep$ +^_pkgdown\.yml$ +^pkgdown$ diff --git a/.gitignore b/.gitignore index 389a6b8f..00211ba8 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ docs/reference/*.pdf .Rproj.user .Rhistory README_files +docs diff --git a/R/soilDB-package.R b/R/soilDB-package.R index d2e1fd28..de571822 100644 --- a/R/soilDB-package.R +++ b/R/soilDB-package.R @@ -3,7 +3,7 @@ #' A collection of functions for reading data from USDA-NCSS soil databases. #' #' This package provides methods for extracting soils information from local -#' PedonPC and AK Site databases (MS Access format), local NASIS databases (MS +#' PedonPC and AKSite databases (MS Access format), local NASIS databases (MS #' SQL Server), Soil Data Access and various other soil-related web services. #' @name soilDB-package #' @aliases soilDB.env soilDB-package soilDB diff --git a/README.Rmd b/README.Rmd index 46e62e4c..674b60cb 100644 --- a/README.Rmd +++ b/README.Rmd @@ -6,7 +6,7 @@ output: md_document [![R-CMD-check Build Status](https://github.com/ncss-tech/soilDB/workflows/R-CMD-check/badge.svg)](https://github.com/ncss-tech/soilDB/actions) [![Total CRAN Downloads](http://cranlogs.r-pkg.org/badges/grand-total/soilDB)](https://cran.r-project.org/package=soilDB) ![CRAN/METACRAN](https://img.shields.io/cran/l/soilDB) -[![soilDB Manual](https://img.shields.io/badge/docs-HTML-informational)](https://ncss-tech.github.io/soilDB/docs) +[![soilDB Manual](https://img.shields.io/badge/docs-HTML-informational)](https://ncss-tech.github.io/soilDB/) ```{r, echo=FALSE, message=FALSE, warning=FALSE} library(rvest) diff --git a/README.md b/README.md index e05b1c5b..c3fd94be 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,9 @@ Status](https://github.com/ncss-tech/soilDB/workflows/R-CMD-check/badge.svg)](ht [![Total CRAN Downloads](http://cranlogs.r-pkg.org/badges/grand-total/soilDB)](https://cran.r-project.org/package=soilDB) ![CRAN/METACRAN](https://img.shields.io/cran/l/soilDB) [![soilDB -Manual](https://img.shields.io/badge/docs-HTML-informational)](https://ncss-tech.github.io/soilDB/docs) +Manual](https://img.shields.io/badge/docs-HTML-informational)](https://ncss-tech.github.io/soilDB/) -Installation ------------- +## Installation Get the stable version (2.6.9) from CRAN: @@ -20,20 +19,17 @@ Get the development version (2.6.10) from GitHub: remotes::install_github("ncss-tech/soilDB", dependencies = FALSE, upgrade = FALSE, build = FALSE) -Website -------- +## Website -- http://ncss-tech.github.io/AQP/ +- -Citation --------- +## Citation Dylan Beaudette, Jay Skovlin, Stephen Roecker and Andrew Brown (2021). soilDB: Soil Database Interface. R package version 2.6.9. -soilDB 2.6.10 -------------- +## soilDB 2.6.10 ### Notices on Database Interfaces @@ -78,8 +74,7 @@ soilDB 2.6.10 - `ISSR800.wcs()` and `mukey.wcs()` now return a result that inherits from `try-error` (and a message) if the Web Coverage Service fails -Functions by Data Source ------------------------- +## Functions by Data Source - SDA - [`fetchSDA`](http://ncss-tech.github.io/soilDB/docs/reference/fetchSDA_component.html) @@ -132,8 +127,7 @@ Functions by Data Source - SoilGrids - [`fetchSoilGrids`](http://ncss-tech.github.io/soilDB/docs/reference/fetchSoilGrids.html) -Miscellaneous Functions ------------------------ +## Miscellaneous Functions - [`estimateSTR`](http://ncss-tech.github.io/soilDB/docs/reference/estimateSTR.html) - [`STRplot`](http://ncss-tech.github.io/soilDB/docs/reference/STRplot.html) @@ -144,8 +138,7 @@ Miscellaneous Functions - [`code`](http://ncss-tech.github.io/soilDB/docs/reference/code.html) - [`get_NOAA_GHCND`](http://ncss-tech.github.io/soilDB/docs/reference/get_NOAA_GHCND.html) -Tutorials and Demonstrations ----------------------------- +## Tutorials and Demonstrations - [fetchKSSL](http://ncss-tech.github.io/AQP/soilDB/KSSL-demo.html) - [SDA\_query](http://ncss-tech.github.io/AQP/soilDB/SDA-tutorial.html) @@ -153,13 +146,11 @@ Tutorials and Demonstrations - [SCAN/SNOTEL Data](http://ncss-tech.github.io/AQP/soilDB/fetchSCAN-demo.html) -Related Packages ----------------- +## Related Packages - [aqp](https://github.com/ncss-tech/aqp) - [sharpshootR](https://github.com/ncss-tech/sharpshootR) -Dependency Graph ----------------- +## Dependency Graph ![](https://cran.microsoft.com/packagedata/graphs/soilDB.png) diff --git a/inst/_pkgdown.yml b/_pkgdown.yml similarity index 74% rename from inst/_pkgdown.yml rename to _pkgdown.yml index 4c1afc37..9065c8cc 100644 --- a/inst/_pkgdown.yml +++ b/_pkgdown.yml @@ -6,3 +6,4 @@ figures: fig.width: 8 fig.height: ~ fig.retina: 2 +url: https://ncss-tech.github.io/soilDB/ diff --git a/man/soilDB-package.Rd b/man/soilDB-package.Rd index f1768a65..f2eb4a65 100644 --- a/man/soilDB-package.Rd +++ b/man/soilDB-package.Rd @@ -11,7 +11,7 @@ A collection of functions for reading data from USDA-NCSS soil databases. } \details{ This package provides methods for extracting soils information from local -PedonPC and AK Site databases (MS Access format), local NASIS databases (MS +PedonPC and AKSite databases (MS Access format), local NASIS databases (MS SQL Server), Soil Data Access and various other soil-related web services. } \seealso{