-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcopier.yml.backup
More file actions
363 lines (312 loc) · 9.18 KB
/
Copy pathcopier.yml.backup
File metadata and controls
363 lines (312 loc) · 9.18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
_subdirectory: template
# Post-generation tasks
_tasks:
- command: git init
description: "Initialize Git repository"
- command: |
if [ "{{ author_name }}" != "Your Name" ]; then
git config user.name "{{ author_name }}"
fi
if [ "{{ author_email }}" != "your.email@example.com" ]; then
git config user.email "{{ author_email }}"
fi
description: "Configure Git user information"
- command: git add .
description: "Stage all files for initial commit"
- command: git commit -m "Initial commit from template-analysis-and-writeup"
description: "Create initial commit with project metadata"
# Basic Project Information
project_name:
type: str
help: What is your project name?
validator: >-
{% if not project_name %}
Project name is required
{% endif %}
short_name:
type: str
help: What is your project's short name? (used for file naming)
validator: >-
{% if not short_name %}
Short name is required
{% elif ' ' in short_name %}
Short name cannot contain spaces
{% endif %}
description:
type: str
help: Brief description of the project
default: A comprehensive data science analysis project
# Author Information
author_name:
type: str
help: Your name or team name
default: "Your Name"
author_email:
type: str
help: Contact email for the project
default: "your.email@example.com"
# === PROJECT STRUCTURE SELECTION ===
project_type:
type: str
help: What type of project are you creating?
choices:
- Minimal Starter (notebooks + basic writeup)
- Full Academic Project (analysis + writeup)
- Analysis Only (data science pipeline)
- Manuscript Only (writing and publications)
- Package Development (software/library)
- Custom (choose components manually)
default: Minimal Starter (notebooks + basic writeup)
# === PRINCIPAL FOLDER SELECTION ===
# These will be auto-calculated based on project_type
include_analysis:
type: bool
help: Include analysis folder (notebooks, scripts, data pipeline)
default: true
when: "{{ project_type == 'Custom (choose components manually)' }}"
include_writeup:
type: bool
help: Include writeup folder (manuscripts, presentations, grants, reports)
default: true
when: "{{ project_type == 'Custom (choose components manually)' }}"
include_infrastructure:
type: bool
help: Include infrastructure folder (Docker, cloud deployment, CI/CD)
default: true
when: "{{ project_type == 'Custom (choose components manually)' }}"
include_misc:
type: bool
help: Include misc folder (utilities, legacy code, experimental features)
default: true
when: "{{ project_type == 'Custom (choose components manually)' }}"
# Project Configuration
programming_language:
type: str
help: Primary programming language
choices:
- Python
- R
- Both
default: Python
python_version:
type: str
help: Python version to use
default: "3.11"
when: "{{ programming_language in ['Python', 'Both'] }}"
# Analysis Components
include_eda_templates:
type: bool
help: Include exploratory data analysis templates
default: true
include_statistical_analysis:
type: bool
help: Include statistical analysis templates
default: true
include_ml_components:
type: bool
help: Include machine learning workflow templates
default: true
# Data Management
data_versioning:
type: bool
help: Include DVC setup for data versioning
default: false
data_validation:
type: bool
help: Include data validation frameworks (Great Expectations, Pandera)
default: false
# Documentation and Reporting
documentation_format:
type: str
help: Primary documentation format
choices:
- Markdown
- Jupyter Notebooks
- Quarto
- RMarkdown
default: Jupyter Notebooks
include_publication_templates:
type: bool
help: Include academic publication templates
default: false
# Experiment Tracking
experiment_tracking:
type: str
help: Experiment tracking platform
choices:
- None
- MLflow
- Weights & Biases
- Neptune
default: None
# CI/CD and Automation
github_actions:
type: bool
help: Add GitHub Actions workflows
default: false
pre_commit_hooks:
type: bool
help: Configure pre-commit hooks for code quality
default: false
# Deployment Options
include_deployment_templates:
type: bool
help: Include deployment templates (Docker, FastAPI, etc.)
default: false
module_name:
type: str
help: Python module name (auto-generated from short_name)
default: "{{ short_name|lower|replace(' ', '_')|replace('-', '_') }}"
when: false # Auto-generated, not user input
# === SUBCOMPONENT SELECTION FOR ANALYSIS ===
include_notebooks:
type: bool
help: Include structured notebook workflow (00-scratch to 10-iteration)
default: true
when: "{{ include_analysis }}"
include_scripts:
type: bool
help: Include production scripts directory (Python, R, shells)
default: true
when: "{{ include_analysis }}"
include_data_pipeline:
type: bool
help: Include data pipeline structure (01_raw to 08_reporting)
default: true
when: "{{ include_analysis }}"
include_testing:
type: bool
help: Include testing framework for data and models
default: true
when: "{{ include_analysis }}"
include_packages:
type: bool
help: Include local package development structure
default: true
when: "{{ include_analysis }}"
# === SUBCOMPONENT SELECTION FOR WRITEUP ===
include_manuscript:
type: bool
help: Include manuscript writing capabilities
default: true
when: "{{ include_writeup }}"
include_presentations:
type: bool
help: Include presentation templates and management
default: true
when: "{{ include_writeup }}"
include_grants:
type: bool
help: Include grant application management
default: true
when: "{{ include_writeup }}"
include_abstracts:
type: bool
help: Include abstract submission management
default: true
when: "{{ include_writeup }}"
include_posters:
type: bool
help: Include poster creation and management
default: true
when: "{{ include_writeup }}"
include_reports:
type: bool
help: Include technical report templates
default: true
when: "{{ include_writeup }}"
include_blog:
type: bool
help: Include blog post templates for informal writing
default: true
when: "{{ include_writeup }}"
# === INFRASTRUCTURE SUBCOMPONENTS ===
include_docker:
type: bool
help: Include Docker configuration
default: true
when: "{{ include_infrastructure }}"
include_cloud_deployment:
type: bool
help: Include cloud deployment templates (AWS, GCP, Azure)
default: true
when: "{{ include_infrastructure }}"
include_virtualization:
type: bool
help: Include VM and container orchestration
default: true
when: "{{ include_infrastructure }}"
include_automation:
type: bool
help: Include automation tools (GitHub Actions, etc.)
default: true
when: "{{ include_infrastructure }}"
# === VERSION CONTROL ENHANCEMENT ===
include_jujutsu:
type: bool
help: Include Jujutsu (jj) version control with Git backend for enhanced academic workflows
default: false
include_fossil:
type: bool
help: Include Fossil SCM for self-contained archives and manuscript versioning
default: false
use_hybrid_vcs:
type: bool
help: Use hybrid version control (Jujutsu + Fossil) for comprehensive research management
default: false
when: "{{ include_jujutsu and include_fossil }}"
# === AUTO-CONFIGURATION BASED ON PROJECT TYPE ===
# These variables auto-configure components based on the selected project_type
_computed_include_analysis:
type: bool
default: >
{%- if project_type in ['Minimal Starter (notebooks + basic writeup)', 'Full Academic Project (analysis + writeup)', 'Analysis Only (data science pipeline)', 'Package Development (software/library)'] -%}
true
{%- elif project_type == 'Manuscript Only (writing and publications)' -%}
false
{%- else -%}
{{ include_analysis }}
{%- endif -%}
when: false
_computed_include_writeup:
type: bool
default: >
{%- if project_type in ['Minimal Starter (notebooks + basic writeup)', 'Full Academic Project (analysis + writeup)', 'Manuscript Only (writing and publications)'] -%}
true
{%- elif project_type in ['Analysis Only (data science pipeline)', 'Package Development (software/library)'] -%}
false
{%- else -%}
{{ include_writeup }}
{%- endif -%}
when: false
_computed_include_infrastructure:
type: bool
default: >
{%- if project_type == 'Full Academic Project (analysis + writeup)' -%}
true
{%- elif project_type in ['Minimal Starter (notebooks + basic writeup)', 'Analysis Only (data science pipeline)', 'Manuscript Only (writing and publications)', 'Package Development (software/library)'] -%}
false
{%- else -%}
{{ include_infrastructure }}
{%- endif -%}
when: false
# === MINIMAL CONFIGURATION OVERRIDES ===
# For Minimal Starter, override complex features to be simpler
_minimal_notebooks_only:
type: bool
default: >
{%- if project_type == 'Minimal Starter (notebooks + basic writeup)' -%}
true
{%- else -%}
false
{%- endif -%}
when: false
_minimal_writeup_only:
type: bool
default: >
{%- if project_type == 'Minimal Starter (notebooks + basic writeup)' -%}
true
{%- else -%}
false
{%- endif -%}
when: false