Title: | Research Project Directory Generator |
---|---|
Description: | Create a project directory structure, along with typical files for that project. This allows projects to be quickly and easily created, as well as for them to be standardized. Designed specifically with scientists in mind (mainly bio-medical researchers, but likely applies to other fields). |
Authors: | Luke Johnston [aut, cre] |
Maintainer: | Luke Johnston <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.7.0.9000 |
Built: | 2025-02-12 06:01:11 UTC |
Source: | https://github.com/rostools/prodigenr |
Creates manuscript/report or slide Quarto file and saves it into
the docs/
folder.
create_doc(type = c("report", "slides")) create_report() create_slides()
create_doc(type = c("report", "slides")) create_report() create_slides()
type |
The file type (e.g. report, slides). |
A created .qmd
file in the docs/
folder.
create_report()
: Creates a report Quarto document in the docs/
folder.
create_slides()
: Creates a Quarto document for making slides in the docs/
folder.
## Not run: create_report() create_slides() ## End(Not run)
## Not run: create_report() create_slides() ## End(Not run)
This starts the project by setting up a common folder and file infrastructure, as well as adding some useful files to start the project. Also adds Git to the project.
setup_project(path)
setup_project(path)
path |
A path to a new directory. |
Project setup with folders and files necessary for a standard research project.
## 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)
## 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)
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()
.
setup_with_git()
setup_with_git()
Adds Git and .gitignore
file to the project.
setup_project()
for starting the project.
Get a list of available templates in a package.
template_list
template_list
An object of class character
of length 2.
Vector of templates available
template_list
template_list