create_ubesp_analysis: Create a UBESP analysis project

Description Usage Arguments Value Examples

View source: R/create.R

Description

This function create a standard UBESP analysis project: * create_ubesp_analisis() creates a UBESP R analysis project

The function can be called on an existing project; you will be asked before any existing files are changed.

Usage

1
2
3
4
5
6
create_ubesp_analysis(
  path,
  affiliation = "ubesp",
  rstudio = rstudioapi::isAvailable(),
  open = interactive()
)

Arguments

path

A path. If it exists, it is used. If it does not exist, it is created, provided that the parent path exists.

affiliation

the affiliaton for the project (default = "ubesp")

rstudio

If TRUE, calls use_rstudio() to make the new supporting package and analysis project into RStudio Projects. If FALSE and a non-package project, a sentinel .here file is placed so that the directory can be recognized as a project by the here or rprojroot packages.

open

If TRUE, activates the new analysis project:

* If RStudio desktop, the package is opened in a new session.
* If on RStudio server, the current RStudio project is activated.
* Otherwise, the working directory and active project is changed.

Value

Path to the newly created project or package, invisibly.

Examples

1
2
3
4
## Not run: 
    create_ubesp_analysis("~/test")

## End(Not run)

CorradoLanera/devubesp documentation built on May 22, 2020, 7:23 p.m.