README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE, echo=FALSE,results='hide'}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# rmddm

<!-- badges: start -->
[![Build Status](https://travis-ci.org/wkdavis/rmddm.svg?branch=master)](https://travis-ci.org/wkdavis/rmddm)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/wkdavis/rmddm?branch=master&svg=true)](https://ci.appveyor.com/project/wkdavis/rmddm)
[![codecov](https://codecov.io/gh/wkdavis/rmddm/branch/master/graph/badge.svg)](https://codecov.io/gh/wkdavis/rmddm)
<!-- badges: end -->

## Overview

rmddm provides Rmarkdown templates for use in data mining, specifically those projects following the [CRISP-DM](https://en.wikipedia.org/wiki/Cross-industry_standard_process_for_data_mining) process. The package is based on the [rticles](https://github.com/rstudio/rticles) package.

## Installation

Installing rmddm from github with:

```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_github("wkdavis/rmddm")
```

## Example

Creating an RMarkdown template with the CRISP-DM structure.

Using rmddm:

```{r example, eval = FALSE}
library(rmddm)
crispdm_report("MyReport.Rmd")
crispdm_report("MiInforme.Rmd", language = "es")
```

Using rmarkdown directly:

```{r example-rmd, eval = FALSE}
library(rmarkdown)
draft("MyReport.Rmd", template = "crispdm_report", package = "rmddm", edit=FALSE)
draft("MiInforme.Rmd", template = "crispdm_report_es", package = "rmddm", edit=FALSE)
```