| Title: | Research Project Directory Generator |
| Version: | 0.7.0 |
| 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). |
| License: | MIT + file LICENSE |
| URL: | https://github.com/rostools/prodigenr, https://rostools.github.io/prodigenr/ |
| BugReports: | https://github.com/rostools/prodigenr/issues |
| Depends: | R (≥ 4.0.0) |
| Imports: | cli, fs, gert, rlang, rprojroot, whisker, withr |
| Suggests: | knitr, rmarkdown, testthat |
| VignetteBuilder: | knitr |
| Encoding: | UTF-8 |
| Language: | en-US |
| RoxygenNote: | 7.3.2 |
| NeedsCompilation: | no |
| Packaged: | 2024-12-13 18:09:52 UTC; luke |
| Author: | Luke Johnston 
[aut, cre] |
| Maintainer: | Luke Johnston <lwjohnst@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2024-12-13 18:30:02 UTC |
prodigenr: 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).
Author(s)
Maintainer: Luke Johnston lwjohnst@gmail.com (ORCID)
See Also
Useful links:
Report bugs at https://github.com/rostools/prodigenr/issues
Create a basic Quarto document from a template.
Description
Creates manuscript/report or slide Quarto file and saves it into
the docs/ folder.
Usage
create_doc(type = c("report", "slides"))
create_report()
create_slides()
Arguments
type |
The file type (e.g. report, slides). |
Value
A created .qmd file in the docs/ folder.
Functions
-
create_report(): Creates a report Quarto document in thedocs/folder. -
create_slides(): Creates a Quarto document for making slides in thedocs/folder.
Examples
## Not run:
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. Also adds Git to 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