-
Notifications
You must be signed in to change notification settings - Fork 5
/
README.Rmd
93 lines (67 loc) · 3.97 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
---
output:
md_document:
variant: gfm
---
# inlmisc
[](https://ci.appveyor.com/project/jfisher-usgs/inlmisc)
[](https://CRAN.R-project.org/package=inlmisc)
[](https://CRAN.R-project.org/package=inlmisc)
[](https://CRAN.R-project.org/package=inlmisc)
[](https://coveralls.io/github/USGS-R/inlmisc?branch=master)
[](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 U.S. Geological Survey (USGS)
Idaho National Laboratory (INL) [Project Office](https://www.usgs.gov/centers/idaho-water-science-center/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)
```
A recent version of [Pandoc](https://pandoc.org/installing.html) (>= 1.12.3)
is also required to run particular examples in the help documentation---[RStudio](https://www.rstudio.com/products/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](https://phantomjs.org/),
which may be installed using the command:
```r
webshot::install_phantomjs()
```
For creating word clouds, the [OptiPNG](http://optipng.sourceforge.net/) 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:
```r
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:
```r
library("inlmisc")
help(package = "inlmisc")
```
## Author
Jason C. Fisher (ORCID iD [0000-0001-9032-8912](https://orcid.org/0000-0001-9032-8912))
## Point of Contact
Jason C. Fisher (<jfisher@usgs.gov>)
## Suggested Citation
To cite **inlmisc** in publications, please use:
```{r "citation", echo=FALSE, results="asis"}
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](https://github.com/USGS-R/inlmisc/issues) or open a [merge request](https://github.com/USGS-R/inlmisc/pull/new/master) to contribute.
```{r, echo=FALSE, results="asis"}
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.