rolemapr

A package to create a series of documents that detail the roles and responsibilities at play within a Target Operating Model

Logo

Installation

Eventually this package may make it to CRAN, but right now follow the latest stable version or the development instructions below.

When it is available, it can be installed directly from CRAN.

install.packages("rolemapr")

However, the latest stable version (if any) could be found on GitHub, and installed using devtools package.

if (!require(devtools)) install.packages("devtools")
devtools::install_github("whjelmar/rolemapr")

If you would like to install the latest development version, you may install the develop branch.

if (!require(devtools)) install.packages("devtools")
devtools::install_github("whjelmar/rolemapr", ref = "develop")

Usage/Examples

TODO

Screenshots

App Screenshot

Demo

Insert link to demo

Features

• blah
• blah
• blah

Running Tests

To run tests, run the following command

devtools::test()

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

API_KEY

ANOTHER_API_KEY

API Reference

Get all items

  GET /api/items

Parameter	Type	Description
api_key	string	Required. Your API key

Get item

  GET /api/items/${id}

Parameter	Type	Description
id	string	Required. Id of item to fetch

add(num1, num2)

Takes two numbers and returns the sum.

## Color Reference

Color	Hex
Example Color	#0a192f
Example Color	#f8f8f8
Example Color	#00b48a
Example Color	#00d1a0

Documentation

Documentation

License

See License.MD

Authors

• (whjelmar?)

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project’s code of conduct.

Acknowledgements

• DataExplorer which was the inspiration for the structure of the package and the genesis of some of the code.
• Awesome Readme Templates
• Awesome README
• How to write a Good readme

Support

For support, email walter@hjelmar.com or join our Slack channel.

Feedback

If you have any feedback, please reach out to us at walter@hjelmar.com

Appendix

FAQ

See FAQ.md

Lessions

See LESSIONS.md

Roadmap

See ROADMAP.md

Tech Stack

Client: TODO

Server: TODO