lvmisc (version 0.1.2)

create_proj: Create a project

Description

Creates a project structure, including sub-directories, and initialization of a git repository.

Usage

create_proj(
  path,
  sub_dirs = "default",
  use_git = TRUE,
  use_gitignore = "default",
  use_readme = TRUE
)

Value

Path to the newly created project, invisibly.

Arguments

path

A path to a directory that does not exist.

sub_dirs

A character vector. If sub_dirs = "default", it creates 'code/', 'data/', 'docs/', 'figures/' and 'tables/' sub-directories. Otherwise, it creates the sub-directories specified in the character vector.

use_git

A logical value indicating whether or not to initialize a git repository. Defaults to TRUE.

use_gitignore

A character vector. If use_gitignore = "default", it adds a .gitignore file with the files generated by your operating system and by R, as well as some common file extensions. The default .gitignore is as generated by gitignore.io. To create a custom .gitignore, add the files to be ignored in a character vector. If you do not want to create a .gitignore file, set use_gitignore = NULL.

use_readme

A logical value. If TRUE (default), adds an empty 'README.md' file.