In USGS-R/inlmisc: Miscellaneous Functions for the USGS INL Project Office

inlmisc

Description

The R package inlmisc is a collection of functions for creating high-level graphics, performing raster-based analysis, processing MODFLOW-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 U.S. Geological Survey (USGS) Idaho National Laboratory (INL) Project Office.

Installation

The current release is available on CRAN, which you can install using the following command:

install.packages("inlmisc", dependencies = TRUE)

A recent version of Pandoc (>= 1.12.3) is also required to run particular examples in the help documentation---RStudio includes this so you do not need to download Pandoc if working in a RStudio IDE. The webshot package is imported from and has as a dependency the external program PhantomJS, which may be installed using the command:

webshot::install_phantomjs()

For creating word clouds, the OptiPNG program is recommended and needs to be accessible through the command window. Finally, to install the development version of inlmisc, you need to clone the repository and build from source, or run:

if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_github("USGS-R/inlmisc", dependencies = TRUE)

Usage

Examples are given in the package help pages. To access this documentation, run:

library("inlmisc")
help(package = "inlmisc")

Author

Jason C. Fisher (ORCID iD 0000-0001-9032-8912)

Point of Contact

Jason C. Fisher ([e-mail])

Suggested Citation

To cite inlmisc in publications, please use:

print(utils::citation(package="inlmisc"), style="textVersion")

Contributing

We welcome your contributions and suggestions for how to make these materials more useful to the community. Please feel free to comment on the issue tracker or open a merge request to contribute.

files <- c("CODE_OF_CONDUCT.md", "DISCLAIMER.md", "LICENSE.md")
for (f in files) {
  txt <- readLines(f, encoding = "UTF-8")
  is <- grepl("^(#+)\\s*(.*)\\s*$", txt)
  txt[is] <- gsub("#\\s", "## ", txt[is])
  cat(txt, "\n\n", sep = "\n")
}

Support

The Idaho National Laboratory Project Office of the USGS supports the development and maintenance of inlpubs. Resources are available primarily for maintenance and responding to user questions. Priorities on the development of new features are determined by the development team.

USGS-R/inlmisc documentation built on Sept. 17, 2022, 2:38 a.m.