Learn R Programming

⚠️There's a newer version (0.5.5) of this package.Take me there.

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)

To install the development version, 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)

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.

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.

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 shall be held liable for any damages resulting from its authorized or unauthorized use.

Copy Link

Version

Install

install.packages('inlmisc')

Monthly Downloads

34

Version

0.5.0

License

CC0

Issues

Pull Requests

Stars

Forks

Maintainer

Jason Fisher

Last Published

July 23rd, 2020

Functions in inlmisc (0.5.0)

AddPoints

Add Points to Plot
FindOptimalSubset

Find Optimal Subset Using a GA
AddColorKey

Add Color Key to Plot
IsColor

Check whether a character string is a valid color specification.
IsPackageInstalled

Check whether Package is Installed
AddIntervals

Add Interval Symbols to Plot
PrintFigure

Print as LaTeX Figure
FormatPval

Format P Values
FindPolyNodes

Find Polygon Nodes
GetDaysInMonth

Get Number of Days in a Year and Month
AddGradientLegend

Add Color Gradient Legend to Plot
RmSmallCellChunks

Remove Small Cell Chunks
GetColors

Get Palette Colors
PrintPackageHelp

Print Package Help Documentation
GetInsetLocation

Get Location for Inset in Plot
SummariseBudget

Summarize MODFLOW Water Budget
PlotCrossSection

Plot Cross Section
POSIXct2Character

Convert from POSIXct to Character
ToScientific

Format for Scientific Notation
ExtractAlongTransect

Extract Raster Values Along a Transect Line
PrintTable

Print as LaTeX Table
usgs_article

USGS Article Format
PlotGraph

Plot Graph
AddInsetMap

Add Inset Map to Plot
RecreateLibrary

Recreate R Library
CreateWebMap

Create a Web Map Using TNM Services
Grid2Polygons

Convert Spatial Grids to Polygons
ReadCodeChunks

Read Knitr Code Chunks
ExportRasterStack

Export a Raster Stack
ReadModflowBinary

Read MODFLOW Binary File
BumpRiverStage

Adjust Implausible River Stage
ReplaceInTemplate

Replace Values in a Template Text
SetPolygons

Overlay Multi-Polygon Objects
PlotMap

Plot Map
GetRegionOfInterest

Get Region of Interest
SetHinge

Set Hinge Location in Color Palette
AddNorthArrow

Add North Arrow to Plot
AddWebMapElements

Add Elements to Web Map
EncodeChromosome

Encode and Decode an Integer Chromosome
AddScaleBar

Add Scale Bar to Plot
BuildVignettes

Build Package Vignettes
BumpDisconnectCells

Adjust Vertically Disconnected Cells
inlmisc-deprecated

Deprecated Functions in the inlmisc Package