diff --git a/.gitignore b/.gitignore index 0cc5ac5..019faeb 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ .Ruserdata .Rprofile tests/testthat/test-my_* +README\.html diff --git a/DESCRIPTION b/DESCRIPTION index a54d596..8468a0b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Package: dplyr.teradata Type: Package -Title: A dplyr Backend for Teradata +Title: A Teradata Backend for dplyr Version: 0.0.0.9000 -Description: A dplyr backend for Teradata. +Description: A Teradata backend for dplyr. Authors@R: person("Koji", "Makiyama", email = "hoxo.smile@gmail.com", role = c("cre", "aut")) License: MIT + file LICENSE Encoding: UTF-8 diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 0000000..81de404 --- /dev/null +++ b/README.Rmd @@ -0,0 +1,43 @@ +--- +title: "A Teradata Backend for dplyr" +author: Koji MAKIYAMA (@hoxo_m) +output: + html_document: + keep_md: true + md_document: + variant: markdown_github +--- + + + +```{r setup, include=FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>", + fig.path = "README-" +) +``` + +[![CRAN Version](http://www.r-pkg.org/badges/version/dplyr.teradata)](https://cran.r-project.org/package=dplyr.teradata) + +## 1. Overview + +## 2. Installation + +You can install the package from GitHub. + +```{r eval=FALSE} +install.packages("devtools") # if you have not installed "devtools" package +devtools::install_github("hoxo-m/dplyr.teradata") +``` + +The source code for **dplyr.teradata** package is available on GitHub at + +- https://github.com/hoxo-m/dplyr.teradata. + +## 3. Details + +## 4. Related work + +- [A Teradata backend for dplyr](https://github.com/xiaodaigh/teradata.dplyr) +- [Dplyr backends: the ultimate collection](https://gist.github.com/piccolbo/3d8ac40291f4eaee644b) diff --git a/README.md b/README.md new file mode 100644 index 0000000..cd36154 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# A Teradata Backend for dplyr +Koji MAKIYAMA (@hoxo_m) + + + + + +[![CRAN Version](http://www.r-pkg.org/badges/version/dplyr.teradata)](https://cran.r-project.org/package=dplyr.teradata) + +## 1. Overview + +## 2. Installation + +You can install the package from GitHub. + + +```r +install.packages("devtools") # if you have not installed "devtools" package +devtools::install_github("hoxo-m/dplyr.teradata") +``` + +The source code for **dplyr.teradata** package is available on GitHub at + +- https://github.com/hoxo-m/dplyr.teradata. + +## 3. Details + +## 4. Related work + +- [A Teradata backend for dplyr](https://github.com/xiaodaigh/teradata.dplyr) +- [Dplyr backends: the ultimate collection](https://gist.github.com/piccolbo/3d8ac40291f4eaee644b)