new_project: Create a new project

View source: R/new_project.R

new_projectR Documentation

Create a new project

Description

This function performs the setup for creating new projects of various types, including analyses, posters, and packages.

Usage

new_project(project.name, dir = ".", type = c("analysis", "poster", "package"))

new_analysis(
  project.name,
  dir = ".",
  use.hpc = TRUE,
  use.git = TRUE,
  use.github = TRUE
)

new_poster(
  project.name,
  dir = ".",
  use.hpc = FALSE,
  use.git = TRUE,
  use.github = TRUE
)

new_package(
  project.name,
  dir = ".",
  use.pkgdown = TRUE,
  use.git = TRUE,
  use.github = TRUE
)

Arguments

project.name

The name of the project.

dir

The root directory of the new project.

type

The type of project

use.hpc

Logical. Should scripts be provided to run analysis on SCINet?

use.git

Initialize a git repository?

use.github

Connect to github?

Details

The function supports the creation of projects of the following types:

analysis

Directory setup and template scripts for conducting an analysis

poster

Directory setup and template copying for producing a poster in LaTeX

package

Setup for creating a new R package

Functions

  • new_analysis():

  • new_poster():

  • new_package():


neyhartj/neyhart documentation built on Jan. 17, 2024, 11:13 a.m.