Add README.Rmd file at top level

Makefile

@@ -55,3 +55,7 @@ tables: install
 	rm -r ../man/figures
 	mv -f figures ../man/
 .PHONY: tables
+
+readme:
+	R -q -e 'rmarkdown::render('\''README.Rmd'\'')'
+.PHONY: readme

NEWS.md

@@ -1,5 +1,7 @@
 # inlmisc 0.5.0
 
+- Add top-level *README.Rmd* file.
+
 - Remove *LICENSE.note* file from package, and replace witha repo-only *LICENSE.md* file.
 
 - Add *DISCLAIMER.md* file.

README.Rmd

@@ -0,0 +1,81 @@
+---
+output:
+  md_document
+---
+
+inlmisc
+=======
+
+[![Travis Build Status](https://travis-ci.org/USGS-R/inlmisc.svg?branch=master)](https://travis-ci.org/USGS-R/inlmisc)
+[![CRAN Version](https://www.r-pkg.org/badges/version/inlmisc)](https://CRAN.R-project.org/package=inlmisc)
+[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/inlmisc?color=brightgreen)](https://CRAN.R-project.org/package=inlmisc)
+[![Dependencies](https://tinyverse.netlify.com/badge/inlmisc)](https://CRAN.R-project.org/package=inlmisc)
+[![Coverage Status](https://coveralls.io/repos/github/USGS-R/inlmisc/badge.svg?branch=master)](https://coveralls.io/github/USGS-R/inlmisc?branch=master)
+[![USGS Category](https://img.shields.io/badge/USGS-Support-yellow.svg)](https://owi.usgs.gov/R/packages.html#support)
+
+Description
+-----------
+
+The [R](https://www.r-project.org/) package **inlmisc** is a collection of functions for creating high-level graphics,
+performing raster-based analysis, processing [MODFLOW](https://www.usgs.gov/mission-areas/water-resources/science/modflow-and-related-programs "USGS's modular hydrologic model")-based models,
+selecting subsets using a genetic algorithm, creating interactive web maps, accessing color palettes, etc.
+Used to support packages and scripts written by researchers at the United States Geological Survey (USGS)
+Idaho National Laboratory (INL) [Project Office](https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office "USGS INL Project Office").
+
+Installation
+------------
+
+The current release is available on [CRAN](https://CRAN.R-project.org/package=inlmisc "The Comprehensive R Archive Network"),
+which you can install using the following command:
+
+```r
+install.packages("inlmisc", dependencies = TRUE)
+```
+
+To install the development version, you need to clone the repository and build from source, or run:
+
+```r
+if (!requireNamespace("remotes")) install.packages("remotes")
+remotes::install_github("USGS-R/inlmisc", dependencies = TRUE)
+```
+
+Usage
+-----
+
+Examples are given in the help files within this package.
+To access this documentation, run:
+
+```r
+library("inlmisc")
+help(package = "inlmisc")
+```
+
+Author
+------
+
+Jason C. Fisher (ORCID iD [0000-0001-9032-8912](http://orcid.org/0000-0001-9032-8912))
+
+Suggested citation
+------------------
+
+```{r "citation", echo=FALSE, results="asis"}
+cit <- utils::citation(package="inlmisc")
+print(cit, bibtex=FALSE)
+```
+
+Contributing
+------------
+
+Please submit bug reports, suggestions, and pull requests to the
+[issues tracker](https://github.com/USGS-R/inlmisc/issues).
+
+Package support
+---------------
+
+The Idaho National Laboratory Project Office of the USGS supports the development and maintenance of inlmisc.
+Resources are available primarily for maintenance and responding to user questions.
+Priorities on the development of new features are determined by the inlmisc development team.
+
+```{r "support", echo=FALSE, results="asis"}
+cat(readLines("DISCLAIMER.md"), sep="\n")
+```

README.md

@@ -1,63 +1,95 @@
 inlmisc
 =======
 
-[![Travis Build Status](https://travis-ci.org/USGS-R/inlmisc.svg?branch=master)](https://travis-ci.org/USGS-R/inlmisc)
-[![CRAN Version](https://www.r-pkg.org/badges/version/inlmisc)](https://CRAN.R-project.org/package=inlmisc)
-[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/inlmisc?color=brightgreen)](https://CRAN.R-project.org/package=inlmisc)
+[![Travis Build
+Status](https://travis-ci.org/USGS-R/inlmisc.svg?branch=master)](https://travis-ci.org/USGS-R/inlmisc)
+[![CRAN
+Version](https://www.r-pkg.org/badges/version/inlmisc)](https://CRAN.R-project.org/package=inlmisc)
+[![CRAN
+Downloads](https://cranlogs.r-pkg.org/badges/inlmisc?color=brightgreen)](https://CRAN.R-project.org/package=inlmisc)
 [![Dependencies](https://tinyverse.netlify.com/badge/inlmisc)](https://CRAN.R-project.org/package=inlmisc)
-[![Coverage Status](https://coveralls.io/repos/github/USGS-R/inlmisc/badge.svg?branch=master)](https://coveralls.io/github/USGS-R/inlmisc?branch=master)
-[![USGS Category](https://img.shields.io/badge/USGS-Support-yellow.svg)](https://owi.usgs.gov/R/packages.html#support)
+[![Coverage
+Status](https://coveralls.io/repos/github/USGS-R/inlmisc/badge.svg?branch=master)](https://coveralls.io/github/USGS-R/inlmisc?branch=master)
+[![USGS
+Category](https://img.shields.io/badge/USGS-Support-yellow.svg)](https://owi.usgs.gov/R/packages.html#support)
 
 Description
 -----------
 
-The [R](https://www.r-project.org/) package **inlmisc** is a collection of functions for creating high-level graphics,
-performing raster-based analysis, processing [MODFLOW](https://www.usgs.gov/mission-areas/water-resources/science/modflow-and-related-programs "USGS's modular hydrologic model")-based models,
-selecting subsets using a genetic algorithm, creating interactive web maps, accessing color palettes, etc.
-Used to support packages and scripts written by researchers at the United States Geological Survey (USGS)
-Idaho National Laboratory (INL) [Project Office](https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office "USGS INL Project Office").
+The [R](https://www.r-project.org/) package **inlmisc** is a collection
+of functions for creating high-level graphics, performing raster-based
+analysis, processing
+[MODFLOW](https://www.usgs.gov/mission-areas/water-resources/science/modflow-and-related-programs "USGS's modular hydrologic model")-based
+models, selecting subsets using a genetic algorithm, creating
+interactive web maps, accessing color palettes, etc. Used to support
+packages and scripts written by researchers at the United States
+Geological Survey (USGS) Idaho National Laboratory (INL) [Project
+Office](https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office "USGS INL Project Office").
 
 Installation
 ------------
 
-The current release is available on [CRAN](https://CRAN.R-project.org/package=inlmisc "The Comprehensive R Archive Network"),
+The current release is available on
+[CRAN](https://CRAN.R-project.org/package=inlmisc "The Comprehensive R Archive Network"),
 which you can install using the following command:
 
-```r
-install.packages("inlmisc", dependencies = TRUE)
-```
+    install.packages("inlmisc", dependencies = TRUE)
 
-To install the development version, you need to clone the repository and build from source, or run:
+To install the development version, you need to clone the repository and
+build from source, or run:
 
-```r
-if (!requireNamespace("remotes")) install.packages("remotes")
-remotes::install_github("USGS-R/inlmisc", dependencies = TRUE)
-```
+    if (!requireNamespace("remotes")) install.packages("remotes")
+    remotes::install_github("USGS-R/inlmisc", dependencies = TRUE)
+
+Usage
+-----
+
+Examples are given in the help files within this package. To access this
+documentation, run:
+
+    library("inlmisc")
+    help(package = "inlmisc")
+
+Author
+------
+
+Jason C. Fisher (ORCID iD
+[0000-0001-9032-8912](http://orcid.org/0000-0001-9032-8912))
+
+Suggested citation
+------------------
+
+To cite inlmisc in publications, please use:
+
+Fisher, J.C., 2020, inlmisc—Miscellaneous functions for the U.S.
+Geological Survey Idaho National Laboratory Project Office: U.S.
+Geological Survey software release, R package, Reston, Va.
 
 Contributing
 ------------
 
-Please submit bug reports, suggestions, and pull requests to the
-[issues tracker](https://github.com/USGS-R/inlmisc/issues).
+Please submit bug reports, suggestions, and pull requests to the [issues
+tracker](https://github.com/USGS-R/inlmisc/issues).
 
 Package support
 ---------------
 
 The Idaho National Laboratory Project Office of the USGS supports the
-development and maintenance of ObsNetQW. Resources are available
+development and maintenance of inlmisc. Resources are available
 primarily for maintenance and responding to user questions. Priorities
-on the development of new features are determined by the ObsNetQW
+on the development of new features are determined by the inlmisc
 development team.
 
 Disclaimer
 ----------
 
-This software has been approved for release by the U.S. Geological Survey
-(USGS). Although the software has been subjected to rigorous review, the USGS
-reserves the right to update the software as needed pursuant to further analysis
-and review. No warranty, expressed or implied, is made by the USGS or the U.S.
-Government as to the functionality of the software and related material nor
-shall the fact of release constitute any such warranty. Furthermore, the
-software is released on condition that neither the USGS nor the U.S. Government
+This software has been approved for release by the U.S. Geological
+Survey (USGS). Although the software has been subjected to rigorous
+review, the USGS reserves the right to update the software as needed
+pursuant to further analysis and review. No warranty, expressed or
+implied, is made by the USGS or the U.S. Government as to the
+functionality of the software and related material nor shall the fact of
+release constitute any such warranty. Furthermore, the software is
+released on condition that neither the USGS nor the U.S. Government
 shall be held liable for any damages resulting from its authorized or
 unauthorized use.

inst/CITATION

@@ -1,7 +1,13 @@
-utils::bibentry(bibtype = "Manual",
-                title   = sprintf("{%s}: %s", meta$Package, meta$Title),
-                author  = eval(parse(text=meta$Authors)),
-                year    = sub("-.*", "", meta$Packaged),
-                note    = sprintf("R package version %s", meta$Version),
-                url     = sprintf("https://CRAN.R-project.org/package=%s",
-                                  meta$Package))
+utils::citHeader(sprintf("To cite %s in publications, please use:", meta$Package))
+
+utils::citEntry(
+  entry = "Manual",
+  author = eval(parse(text=meta$Authors)),
+  title = "inlmisc---Miscellaneous functions for the U.S. Geological Survey Idaho National Laboratory Project Office",
+  address = "Reston, Va.",
+  year = "2020",
+  note = sprintf("R package version %s", meta$Version),
+  url = "https://CRAN.R-project.org/package=inlmisc",
+  key = "inlmisc-package",
+  textVersion = "Fisher, J.C., 2020, inlmisc---Miscellaneous functions for the U.S. Geological Survey Idaho National Laboratory Project Office: U.S. Geological Survey software release, R package, Reston, Va."
+)