https://github.com/preethinarayanan/R-Package-Development
https://github.com/preethinarayanan/R-Package-Development
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/preethinarayanan/R-Package-Development
- Owner: preethinarayanan
- License: other
- Created: 2020-09-21T18:43:23.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-08T19:31:33.000Z (over 4 years ago)
- Last Synced: 2024-08-13T07:14:05.062Z (8 months ago)
- Language: R
- Size: 78.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - preethinarayanan/R-Package-Development - (R)
README
# **kittens**
### Model Development & Data Exploratory Toolkit
**Arrowhead General Insurance Agency**
---
### **Overview**
This package is created to help the data science team at Arrowhead work more efficiently. This package include analytical functions including: modeling, exploring, and data manipulation.
For more information about the package, please contact the data science help email at [email protected]
### **Installation**
#### RSSP Install
Kittens is avaialble as a private repository on RSSP. You must add the private repository, and then install it. If you already have it installed in your own library, uninstall it, then follow the instructions below.
Add the local/private package repository to RSSP IDE:
a. Tools -> Global Options -> Packages
b. Add a repository
c. Name: arrowhead
d. Url: file:///arrowhead-r-pkgs
Then in your R Console run:
```
install.packages("kittens")
```
#### Local Install
Clone this repository then run use `devtools` package to install `kittens`.
```
devtools::install()
```
### **Contributing**
Please use the following convention when adding functions / features to this package:
1. Instantiate the `feature-name` branch
2. Instantiate the `feature-name_dev-name` sub-branch
3. Treat the `feature-name` branch as master branch to `feature-name_dev-name`
4. When the `feature-name` branch is ready for primetime, create a Pull Request
Function Naming Standardization:
1. Use Camel case style for our function names. (e.g. `MakeNames()`, `ModelBinomial()`)