This is a small outline of folders of the template.
| Folder | Function |
|---|---|
| code/ | Stores your code scripts. |
| data/ | Stores raw or original data. |
| doc/ | Documents generated during the project. |
| figs/ | Figures and graphs, or other kind of images. |
| LicenseTemplates/ | Templates in markdown format for licenses for code and content. |
| notes/ | Notes or diary documents. |
| output/ | Other outputs, like CSVs to share data. |
| R/ | Scripts with functions created for this project. |
| var/ | Stores your processed of intermediate data or variables. |
Small outline of the files in the root of this project
| File | Function |
|---|---|
| CONTRIBUTING-template.md | A template file to explain how to contribute to your project. |
| CONTRIBUTING.md | The file that explain how to contribute to this project. |
| LICENSE.md | The license I attribute to the code in this project. |
| LICENSE4CONTENT.md | The license of the media files of this project. |
| README-template.md | A README file template to you to modify for your project. |
| README.md | This is the README file of this project and you are reading it right now. |
| TODO-template.md | A TODO file you can use in your project. |
| TODO.md | The pending tasks to-do in this project. |
You can clone, fork or directly download this project to use it. If you want to clone it using Git on the shell use the following command in the folder where you want to clone.
git clone https://github.com/luisspuerto/R-Proj-Template.git
Once you have the files I recommend you to choose a license for your the code and the content of your project, even more if you are going to share the project in GitHub, and then delete the LicenseTemplates/ folder. Check the License section in this document to find out more.
I recommend you delete the files related to this project itself and then use the -template ones in your project.
Please fell free to comment or even contribute to this project in anyway you want to this template, this is just a beginning and I want to make as useful as possible to anyone.
I've included a CONTRIBUTING document in this template project, as well a contributing document template.
This is a small code of conduct that explain how to contribute to this project. It's adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
What things you need to install the software and how to install them
Give examples
- R - Software environment for statistical computing and graphics
- RStudio - a free and open-source integrated development environment (IDE) for R
- MacDown - Markdown Editor
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
The code of this project is licensed under GNU General Public License v3.0 –see the LICENSE.md file for more details. The rest of the content of this project is licensed under Attribution-NonCommercial-ShareAlike 4.0 International –see the LICENSE4CONTENT.md for more details.
It seems that the license for R code is something tricky. R is distributed under GNU General Public License v2.0 and some people argue that since R script are a derivative work from R libraries you need to distribute you R scripts under the same license.
I've been inspired to create this template after I've read the following posts in the blog Nice R Coding of @richfitz
I know about the ProjectTemplate and I think it's really impressive how complex a R project can be and how detailed that template is. However, I find it too complicated for my needs and for a lot of people starting in R or don't do that complicated project everyday.
This template tries to be an intermediate template for people that doesn't need to automate that much when they are scripting in R, but they would like to have some kind of template to help them every time they create a new project and keep common structure in all their projects.