rostools / prodigenr Goto Github PK

Project directory generator R package

Home Page: http://rostools.github.io/prodigenr

License: Other

R 100.00%

rstats reproducible-research reproducible-science open-source open-science reproducibility project-management rstudio usethis devtools

prodigenr's Introduction

rostools

The goal of rostools is to ...

Installation

You can install the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("lwjohnst86/rostools")

Example

In development...

Contributing

For more information on contributing, see this documentation Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

prodigenr's People

Contributors

Stargazers

Watchers

Forkers

guhjy ycphs jcolomb kristijanarmeni gitter-badger jdblischak pzhaonet vinhnguyendo jimsforks ccmslih mayrop yyzeng agdamsbo

prodigenr's Issues

Use RStudio addins functionality to run Rmd's in doc/

also target non-R users?

Add reference html link to introduction (and flesh that out more) in the readme

Incorporate `lay_base` into `build`

At the time it made sense to have the separate. However, now that I think of it, they should be one function.

Include the load_data code into zzz.R

Create a project template for a course or teaching lesson

Include TODO list with first few todos?

i.e. for using git done?

Reference projecttemplate r package in readme/vignette

Move individual files (like poster + template, etc) to be added to other projects

For instance, I want to create an abstract project, but maybe eventually include the poster/slides that may come of it, without having to create a new project.

update resources

include the workflowr package (on github)

create a command to make a tag of the version that also adds it to the DESCRIPTION

Use packagedocs R package?

For building websites and for future research projects?

Include in README template how to install all packages to use for project

Like I did with contributing in PROMISE

Allow `build` to be used multiple times and added to the results data.frame

Kinda like I did in carpenter with the add_rows.

Move R/ files into their own inst/templates/files folder and copy from there

I've changed the R/ files enough times that it doesn't make sense to have to change all of them each time. So I need to move them into one location and copy from there. Try to do that with the other files too if need be.

Add other available packages similar to this

Like https://github.com/cboettig/template

Test out having manuscript, etc in vignette

Add LICENSE template

use doc/ instead of vignettes/

For the main document, use doc/ since vignette does not generate non-vignette documents.

Use package desc for adding and editing DESCRIPTION

Use osi package for adding license information

see https://github.com/Ironholds/osi/

Include in README about restarting session + loading .rprofile

Change poster to use Sweave rather than Rmd

Include non-code projects (e.g. opinion pieces, lit reviews, etc).

This could still have the DESCRIPTION file, etc.

Added a section in README to fill out to describe project

Make a diagram of the workflow in the readme of the templates

This should help beginners know how each file/script interacts with each other.

Add function to set up script to send to figshare

Added devtools to be loaded automatically so it's functions can be used without `devtools::`

Create a function (like `devtools::install()`) that knits the main project files (poster, manuscript, etc.)

Create a project template for a Rmd blog post

Add a function to newly created project to use `.onLoad` to run load_data etc

make a function like rmarkdown::draft but specific to the project

Doc/ instead of vignette/?

Because of an issues (restriction really) of using vignettes and outputing to other formats when a document is a vignette, maybe I should put the documents in like inst/doc, or just doc/ or something. And additional analyses in vignette/...

use a command that renders manuscript etc into word when it is in the vignette

something like:

render("manuscript.Rmd", "word_document")