Package 'archetyper'

Title: An Archetype for Data Mining and Data Science Projects
Description: A project template to support the data science workflow.
Authors: Michael Korvink [aut, cre, com], Matthew Nethery [ctb], Franck Diaz-Garelli [ctb]
Maintainer: Michael Korvink <[email protected]>
License: GPL (>= 3)
Version: 0.1.0
Built: 2025-03-01 04:38:32 UTC
Source: https://github.com/mkorvink/archetyper

Help Index


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

Description

generates a demo project using archetyper

Usage

generate_demo(path = tempdir())

Arguments

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)