genesee_skeleton: Initialize a Genesee project

View source: R/project-setup.R

genesee_skeletonR Documentation

Initialize a Genesee project

Description

This creates a set of directories, activates renv, copies down templated shell scripts. The next step is to run make_sample_sheet.

Usage

genesee_skeleton(
  genesee_root,
  investigator,
  project_title,
  init_templates = TRUE,
  init_git = TRUE,
  use_renv = FALSE,
  project_type = "scRNA",
  authors = "default",
  force = FALSE,
  navigate_rawdata = TRUE
)

Arguments

genesee_root

character naming a containing all genesee projects

investigator

character naming PI of project

project_title

character naming project

init_templates

logical Should template markdown, shell scripts, etc, be copied?

init_git

logical should a git repo be initialized?

use_renv

logical Should renv be initialized?

project_type

character, one of scRNA, RNA or scVDJ

authors

character containing the authors/editors of the project

force

logical force creation of a project

navigate_rawdata

logical should we shift focus to the rstudio terminal opened on the rawdata directory

Value

TRUE on success


amcdavid/Genesee documentation built on April 14, 2022, 5:16 a.m.