In data-science-competitions/IEEE-CIS-Fraud-Detection: R Project Template for Analytic Applications such as Machine Learning Competitions

source("README.R", TRUE)
knitr::opts_chunk$set(echo = TRUE, fig.align = "center", out.width = "100%")

#######################
## Get Project Paths ##
#######################
path_project <- getwd()
while (length(grep("test", path_project))>0) path_project <- dirname(path_project)
devtools::load_all(path_project)

############################# 
## Get Package DESCRIPTION ##
#############################
library(desc)
target <- file.path(path_project, "DESCRIPTION")
desc_obj <- description$new(target)

##########################
## Set System Variables ##
##########################
package_url <- desc_obj$get_field("BugReports") %>% stringr::str_remove("/issues$")
package_name <- desc_obj$get_field("Package")
package_repo <- stringr::str_extract_all(package_url, "[^/]+(?://[^/]*)*")[[1]][2:3] %>% paste0(collapse ="/")
Sys.setenv(CI_PROJECT_NAME = package_name)
Sys.setenv(CI_PROJECT_URL = package_url)

####################
## Construct URLs ##
####################
travis_url <- paste0("https://travis-ci.org/", package_repo)
pipeline_url <- paste0(travis_url, ".svg?branch=master")
mybinder_url <- "http://mybinder.org/badge.svg"

codecov_url <- paste0("https://codecov.io/github/", package_repo, "/", "?branch=master")
covr_url <- paste0("https://codecov.io/gh/", package_repo, "/branch/master/graph/badge.svg")
binder_url <- paste0("https://mybinder.org/v2/gh/", package_repo, "/master?urlpath=rstudio")

r package_name

r desc_obj$get_field("Title")

---

knitr::include_graphics("https://i.imgur.com/RLEQkhe.png")

Overview

r desc_obj$get_field("Description")

Useage

1. Create a new repo on GitHub.
2. Use the git-flow approach in your development cycle.
3. Create a new release named inception.
4. Copy r package_name content to the new reposetory.
5. Change the r paste0(package_name,".Rproj") file to <package-name>.Rproj.
6. Open the DESCRIPTION file, and edit the following fields:
7. Package modify the package name while using the tidylab. prefix.
8. Title modify the package title; use uppercase words with no period ('.').
9. URL modify the package URL such that it leads to its GitHub repo.
10. BugReports edit the URL such that it leads to the package issue page.
11. Description modify the package decription.
12. In README.Rmd delete the Useage Section.
13. Render README.Rmd by clicking the Knit button.
14. Push changed on the inception branch.
15. Go to Travis website, add the project and enable its integration.
16. Decide if you would need binder -- an RStudio Server that lets you demonstrate the package. If you do then:
17. Uncomment build-binder under .travis.yml; and
18. Uncomment Launch Rstudio Binder from README.Rmd.

Installation

You can install r package_name by using:

install.packages("devtools")
devtools::install_github("`r package_repo`")

Function Dependencies

plot_function_dependencies(package_name)

Datasets

plot_datasets_overview(x = list(mtcars = mtcars, iris = iris))

data-science-competitions/IEEE-CIS-Fraud-Detection documentation built on Nov. 4, 2019, 9:40 a.m.