Help for package archetyper

Type:

Package

Title:

An Archetype for Data Mining and Data Science Projects

Version:

0.1.0

Maintainer:

Michael Korvink <mkorvink@protonmail.com>

Description:

A project template to support the data science workflow.

License:

GPL (≥ 3)

URL:

https://mkorvink.github.io/archetyper/index.html

BugReports:

https://github.com/mkorvink/archetyper/issues

Encoding:

UTF-8

LazyData:

true

Imports:

here, knitr, log4r, config, tidyverse, rmarkdown, skimr, stringr, snakecase, testthat (≥ 3.0.0), bannerCommenter, feather, readr, ps

RoxygenNote:

7.1.1

Suggests:

RCurl, MASS, broom, caret, covr, gtsummary, performance, kableExtra

VignetteBuilder:

knitr

Config/testthat/edition:

Depends:

R (≥ 2.10)

NeedsCompilation:

Packaged:

2021-03-15 14:27:48 UTC; Michael_Korvink

Author:

Michael Korvink [aut, cre, com], Matthew Nethery [ctb], Franck Diaz-Garelli [ctb]

Repository:

CRAN

Date/Publication:

2021-03-17 14:00:05 UTC

generates a set of files and directories to support both the data mining and data science workflow.

Description

generates a set of files and directories to support both the data mining and data science workflow.

Usage

generate(
  project_name,
  db_connection_type = "",
  exclude = as.character(),
  path = tempdir()
)

Arguments

project_name

The name of the project to be generated.

db_connection_type

A optional string indicating if a "JDBC" or "ODBC" connection will be used in the project. Options include: "jdbc" or "odbc"

exclude

A character vector of components to exclude from generation. Options include: "0_test.R", "1_integrate.R", "2_enrich.R", "3_model.R", "4_evaluate.R", "5_present.Rmd", "common.R", "mediator.R", "utilities.R", "explore.R", "api.R", "lint.R", ".gitignore", "readme.md", "config.yml"

path

The path where the project should be created. Default is a temporary directory: tempdir().

Value

No return value.

Examples

## Not run: 
generate("majestic_12")

## End(Not run)

generates a demo project using archetyper