Package 'prodigenr'

Create a basic R Markdown document from a template.

Description

Creates manuscript/report or slide R Markdown file and saves it into the ⁠doc/⁠ folder.

Usage

create_doc(type = c("report", "slides"))

create_report()

create_manuscript()

create_slides()

Arguments

type	The file type (e.g. report, slides).

Value

A created .Rmd file in the ⁠doc/⁠ folder.

Functions

• create_report(): Creates a report R Markdown document in the ⁠doc/⁠ folder.

• create_manuscript(): Creates a manuscript R Markdown document in the ⁠doc/⁠ folder. Is the same as create_report().

• create_slides(): Creates a R Markdown document for making slides in the ⁠doc/⁠ folder.

Examples

## Not run: 
create_manuscript()
create_report()
create_slides()

## End(Not run)

---

Setup a standardized folder and file structure for a research analysis project.

Description

This starts the project by setting up a common folder and file infrastructure, as well as adding some useful files to start the project.

Usage

setup_project(path)

Arguments

path	A path to a new directory.

Value

Project setup with folders and files necessary for a standard research project.

Examples

## Not run: 
# Use a temporary location
new_proj_name <- fs::path_temp("DiabetesCancer")
setup_project(new_proj_name)
# After the new project opens up, add Git with:
setup_with_git()

## End(Not run)

---

Setup Git to the project.

Description

Takes a lot of inspiration from the usethis use_git() function, except it only adds Git and nothing more (doesn't commit, doesn't restart RStudio automatically). Must run this function inside the project you created from setup_project().

Usage

setup_with_git()

Value

Adds Git and .gitignore file to the project.

See Also

setup_project() for starting the project.

---

List project templates within prodigenr.

Description

Get a list of available templates in a package.

Usage

template_list

Format

An object of class character of length 2.

Value

Vector of templates available

Examples

template_list

---