Skip to content

Commit

Permalink
Use pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
brownag committed Dec 14, 2021
1 parent de0ac07 commit 983b844
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 23 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ README.Rmd
^cran-comments\.md$
^CRAN-RELEASE$
^revdep$
^_pkgdown\.yml$
^pkgdown$
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ docs/reference/*.pdf
.Rproj.user
.Rhistory
README_files
docs
2 changes: 1 addition & 1 deletion R/soilDB-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
31 changes: 11 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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

- <a href="http://ncss-tech.github.io/AQP/" class="uri">http://ncss-tech.github.io/AQP/</a>
- <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.
<https://CRAN.R-project.org/package=soilDB>

soilDB 2.6.10
-------------
## soilDB 2.6.10

### Notices on Database Interfaces

Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -144,22 +138,19 @@ 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)
- [fetchOSD](http://ncss-tech.github.io/AQP/sharpshootR/OSD-dendrogram.html)
- [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)
1 change: 1 addition & 0 deletions inst/_pkgdown.yml → _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ figures:
fig.width: 8
fig.height: ~
fig.retina: 2
url: https://ncss-tech.github.io/soilDB/
2 changes: 1 addition & 1 deletion man/soilDB-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 983b844

Please sign in to comment.