https://github.com/trinker/textproj

https://github.com/trinker/textproj

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/trinker/textproj
• Owner: trinker
• Created: 2016-01-17T14:43:44.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-04-14T17:51:21.000Z (about 9 years ago)
• Last Synced: 2025-02-14T12:41:03.132Z (over 1 year ago)
• Language: R
• Size: 142 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS

Awesome Lists containing this project

README

          
---

title: "textproj"

date: "`r format(Sys.time(), '%d %B, %Y')`"

output:

  md_document:

    toc: true      

---

```{r, echo=FALSE}

desc <- suppressWarnings(readLines("DESCRIPTION"))

regex <- "(^Version:\\s+)(\\d+\\.\\d+\\.\\d+)"

loc <- grep(regex, desc)

ver <- gsub(regex, "\\2", desc[loc])

verbadge <- sprintf('', ver, ver)

````

[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)

[![Build Status](https://travis-ci.org/trinker/textproj.svg?branch=master)](https://travis-ci.org/trinker/textproj)

`r verbadge`

![](tools/textproj_logo/r_textproj.png)

**textproj** is a project template for text projects.  The package has one function, `text_project`.  It creates the following structure of subdirectories and files:

```

template

    |

    |   .Rproj

    |   

    +---data

    +---output

    +---plots

    +---reports

    \---scripts

            01_data_cleaning.R

            02_initial_analysis.R

```

# Installation

To download the development version of **textproj**:

Download the [zip ball](https://github.com/trinker/textproj/zipball/master) or [tar ball](https://github.com/trinker/textproj/tarball/master), decompress and run `R CMD INSTALL` on it, or use the **pacman** package to install the development version:

```r

if (!require("pacman")) install.packages("pacman")

pacman::p_load_gh("trinker/textproj")

```

# Contact

You are welcome to:    

- submit suggestions and bug-reports at:        

- send a pull request on:     

- compose a friendly e-mail to: