Skip to content
Snippets Groups Projects
Commit 0f76f021 authored by Fisher, Jason C.'s avatar Fisher, Jason C.
Browse files

Merge branch 'develop' into 'develop'

Add logo image

See merge request !1
parents a8cb1a29 117a2e1f
No related branches found
No related tags found
2 merge requests!5Merge in develop and bump version,!1Add logo image
Pipeline #304758 passed
Showing with 540 additions and 32 deletions
......@@ -21,3 +21,4 @@
^.*\.Rproj$
^\.Rproj\.user$
^variables$
\.ai$
......@@ -4,19 +4,17 @@ output:
variant: markdown_github
---
# inlcolor
# inlcolor <img src="man/figures/logo.png" alt="inlcolor" align="right" />
[![USGS Category](https://img.shields.io/badge/USGS-Research-blue.svg)](https://owi.usgs.gov/R/packages.html#research)
[![CRAN Version](https://www.r-pkg.org/badges/version/inlcolor)](https://CRAN.R-project.org/package=inlcolor)
[![pipeline status](https://code.usgs.gov/inl/inlcolor/badges/main/pipeline.svg)](https://code.usgs.gov/inl/inlcolor/-/commits/main)
[![coverage report](https://code.usgs.gov/inl/inlcolor/badges/main/coverage.svg)](https://code.usgs.gov/inl/inlcolor/-/commits/main)
[![usgs-category-image]][usgs-category-link]
[![cran-version-image]][cran-version-link]
[![pipeline-status-image]][pipeline-status-link]
[![coverage-status-image]][coverage-status-link]
## Description
The [R] package **inlcolor** provides access to a variety of color schemes. Used to support packages and scripts written by researchers at the United States Geological Survey (USGS) Idaho National Laboratory Project Office ([INLPO]). Key features of this package are (1) a simple and consistent API, (2) support for qualitative, diverging, and sequential color schemes, (3) support for combining color pallets using a hinge location, (4) simulates color blindness, and (5) has few dependencies. The goal of **inlcolor** is to be a single comprehensive collection of color schemes for maps and graphs in INLPO publications.
![](man/figures/colors.png)
## Installation
The current release is available on [CRAN], which you can install using the following command:
......@@ -107,6 +105,15 @@ cat(s)
<!-- Embedded References -->
[usgs-category-image]: https://img.shields.io/badge/USGS-Research-blue.svg
[usgs-category-link]: https://owi.usgs.gov/R/packages.html#support
[cran-version-image]: https://www.r-pkg.org/badges/version/inlcolor
[cran-version-link]: https://CRAN.R-project.org/package=inlcolor
[pipeline-status-image]: https://code.usgs.gov/inl/inlcolor/badges/main/pipeline.svg
[pipeline-status-link]: https://code.usgs.gov/inl/inlcolor/-/commits/main
[coverage-status-image]: https://code.usgs.gov/inl/inlcolor/badges/main/coverage.svg
[coverage-status-link]: https://code.usgs.gov/inl/inlcolor/-/commits/main
[R]: https://www.r-project.org/
[INLPO]: https://www.usgs.gov/centers/idaho-water-science-center/science/idaho-national-laboratory-project-office
[CRAN]: https://CRAN.R-project.org/package=inlcolor
......
# inlcolor
inlcolor <img src="man/figures/logo.png" alt="inlcolor" align="right" />
========================================================================
[![USGS
Category](https://img.shields.io/badge/USGS-Research-blue.svg)](https://owi.usgs.gov/R/packages.html#research)
[![CRAN
Version](https://www.r-pkg.org/badges/version/inlcolor)](https://CRAN.R-project.org/package=inlcolor)
[![pipeline
status](https://code.usgs.gov/inl/inlcolor/badges/main/pipeline.svg)](https://code.usgs.gov/inl/inlcolor/-/commits/main)
[![coverage
report](https://code.usgs.gov/inl/inlcolor/badges/main/coverage.svg)](https://code.usgs.gov/inl/inlcolor/-/commits/main)
[![usgs-category-image](https://img.shields.io/badge/USGS-Research-blue.svg)](https://owi.usgs.gov/R/packages.html#support)
[![cran-version-image](https://www.r-pkg.org/badges/version/inlcolor)](https://CRAN.R-project.org/package=inlcolor)
[![pipeline-status-image](https://code.usgs.gov/inl/inlcolor/badges/main/pipeline.svg)](https://code.usgs.gov/inl/inlcolor/-/commits/main)
[![coverage-status-image](https://code.usgs.gov/inl/inlcolor/badges/main/coverage.svg)](https://code.usgs.gov/inl/inlcolor/-/commits/main)
## Description
Description
-----------
The [R](https://www.r-project.org/) package **inlcolor** provides access
to a variety of color schemes. Used to support packages and scripts
......@@ -23,9 +21,8 @@ simulates color blindness, and (5) has few dependencies. The goal of
**inlcolor** is to be a single comprehensive collection of color schemes
for maps and graphs in INLPO publications.
![](man/figures/colors.png)
## Installation
Installation
------------
The current release is available on
[CRAN](https://CRAN.R-project.org/package=inlcolor), which you can
......@@ -48,7 +45,8 @@ remotes::install_gitlab(
)
```
## Usage
Usage
-----
The package provides two main functions for interacting with color
palettes:
......@@ -67,25 +65,30 @@ library("inlcolor")
help(package = "inlcolor")
```
## Authors
Authors
-------
Jason C. Fisher ([ORCID iD
0000-0001-9032-8912](https://orcid.org/0000-0001-9032-8912))
## Point of Contact
Point of Contact
----------------
Jason C. Fisher (<jfisher@usgs.gov>)
Jason C. Fisher
(<a href="mailto:jfisher@usgs.gov" class="email">jfisher@usgs.gov</a>)
## Suggested Citation
Suggested Citation
------------------
To cite **inlcolor** in publications, please use:
Fisher, J.C., 2023, inlcolor—Color palettes for the U.S. Geological
Survey Idaho National Laboratory Project Office: U.S. Geological Survey
software release, R package, Reston, Va.,
<https://doi.org/10.5066/P93BDACR>.
<a href="https://doi.org/10.5066/P93BDACR" class="uri">https://doi.org/10.5066/P93BDACR</a>.
## Contributing
Contributing
------------
We welcome your contributions and suggestions for how to make these
materials more useful to the community. Please feel free to comment on
......@@ -93,7 +96,8 @@ the [issue tracker](https://code.usgs.gov/inl/inlcolor/-/issues) or open
a [merge request](https://code.usgs.gov/inl/inlcolor/-/merge_requests)
to contribute.
## Code of Conduct
Code of Conduct
---------------
All contributions to- and interactions surrounding- this project will
abide by the [USGS Code of Scientific
......@@ -101,7 +105,8 @@ Conduct](https://www.usgs.gov/office-of-science-quality-and-integrity/fundamenta
<!-- Embedded References -->
## Disclaimer
Disclaimer
----------
This software is preliminary or provisional and is subject to revision.
It is being provided to meet the need for timely best science. The
......@@ -116,7 +121,8 @@ authorized or unauthorized use of the software.
Any use of trade, product, or firm names is for descriptive purposes
only and does not imply endorsement by the U.S. Government.
## License
License
-------
Unless otherwise noted, this project is in the public domain in the
United States because it contains materials that originally came from
......@@ -157,7 +163,8 @@ the author or the affirmer.
<!-- Embedded References -->
## Support
Support
-------
The Idaho National Laboratory Project Office of the USGS supports the
development and maintenance of **inlcolor**. Resources are available
......@@ -165,7 +172,8 @@ primarily for maintenance and responding to user questions. Priorities
on the development of new features are determined by the development
team.
## Additional Publication Details
Additional Publication Details
------------------------------
Additional metadata about this publication, not found in other parts of
the page is in this table.
......
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
This diff is collapsed.
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
......@@ -6,6 +6,8 @@
\alias{inlcolor-package}
\title{inlcolor: Color Schemes for the USGS Idaho National Laboratory Project Office}
\description{
\if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}}
A collection of functions for creating color schemes. Used to support packages and scripts written by researchers at the United States Geological Survey (USGS) Idaho National Laboratory Project Office.
}
\seealso{
......
File moved
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
pkgdown/favicon/favicon.ico

14.7 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment