Skip to content

Commit ec42b4c

Browse files
committed
docs: add authorship, citation guidelines, and metadata for the guide
1 parent dce7c55 commit ec42b4c

4 files changed

Lines changed: 56 additions & 0 deletions

File tree

‎CITATION.cff‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
cff-version: 1.2.0
2+
message: "If you use this guide, please cite it using this metadata."
3+
title: "Practical GenAI Coding Guide"
4+
abstract: "A practical 8-step process for integrating GenAI tools into coding and research workflows for biostatistics, bioinformatics, data science, and research teams."
5+
authors:
6+
- family-names: "Fritsche"
7+
given-names: "Lars G."
8+
affiliation: "University of Michigan"
9+
website: "https://medschool.umich.edu/profile/4980/lars-fritsche"
10+
repository-code: "https://github.com/FritscheLab/practical-genai-coding-guide"
11+
url: "https://FritscheLab.github.io/practical-genai-coding-guide/"
12+
license: "GPL-3.0-only"
13+
keywords:
14+
- "generative AI"
15+
- "large language models"
16+
- "coding"
17+
- "reproducible research"
18+
- "biostatistics"
19+
- "bioinformatics"

‎README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
Welcome to this repository containing a **practical textbook** on integrating Large Language Models (LLMs) into coding and research workflows. This guide is geared toward **biostatisticians, bioinformaticians, and data scientists**, providing hands-on steps and examples to enhance productivity and maintain rigorous standards when employing GenAI tools.
44

5+
## Authorship and Maintainer
6+
7+
This guide is created and maintained by [Lars G. Fritsche, PhD](https://medschool.umich.edu/profile/4980/lars-fritsche), Research Associate Professor of Anesthesiology in the University of Michigan Medical School and Research Associate Professor of Biostatistics in the University of Michigan School of Public Health. Repository stewardship is through the [Fritsche Lab](https://github.com/FritscheLab).
8+
9+
## How to Cite
10+
11+
If you use this guide in teaching, documentation, analysis workflows, or publications, please cite the repository:
12+
13+
> Fritsche, Lars G. *Practical GenAI Coding Guide: A practical 8-step process for integrating GenAI tools into coding and research workflows*. Fritsche Lab, University of Michigan. https://FritscheLab.github.io/practical-genai-coding-guide/. Accessed YYYY-MM-DD.
14+
15+
Citation metadata is available in [`CITATION.cff`](CITATION.cff) for GitHub and reference managers.
16+
517
## Repository Overview
618

719
- **Chapters**

‎_config.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@ title: Practical GenAI Coding Guide
22
description: A practical 8-step process for integrating GenAI tools into coding and research workflows.
33
theme: just-the-docs
44

5+
author:
6+
name: "Lars G. Fritsche"
7+
affiliation: "University of Michigan"
8+
profile_url: "https://medschool.umich.edu/profile/4980/lars-fritsche"
9+
biostat_profile_url: "https://sph.umich.edu/faculty-profiles/fritsche-lars.html"
10+
github_org: "https://github.com/FritscheLab"
11+
512
url: "https://FritscheLab.github.io"
613
baseurl: "/practical-genai-coding-guide"
714
repository: FritscheLab/practical-genai-coding-guide
@@ -32,6 +39,12 @@ enable_copy_code_button: true
3239
back_to_top: true
3340
back_to_top_text: "Back to top"
3441

42+
footer_content: >-
43+
Maintained by <a href="https://medschool.umich.edu/profile/4980/lars-fritsche">Lars G. Fritsche, PhD</a>
44+
and the <a href="https://github.com/FritscheLab">Fritsche Lab</a>
45+
(<a href="https://sph.umich.edu/faculty-profiles/fritsche-lars.html">Biostatistics profile</a>).
46+
Distributed under the <a href="https://www.gnu.org/licenses/gpl-3.0.html">GNU GPL v3.0</a>.
47+
3548
callouts_level: quiet
3649
callouts:
3750
takeaway:

‎index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ description: A practical textbook on integrating GenAI tools into coding and res
99

1010
This guide presents a practical 8-step process for using Large Language Models (LLMs) in coding and research workflows while preserving rigor, reproducibility, and human review. It is written for biostatisticians, bioinformaticians, data scientists, and research teams working with analytical code.
1111

12+
## About This Guide
13+
14+
This guide is created and maintained by [Lars G. Fritsche, PhD](https://medschool.umich.edu/profile/4980/lars-fritsche), Research Associate Professor of Anesthesiology in the University of Michigan Medical School and Research Associate Professor of Biostatistics in the University of Michigan School of Public Health. Repository stewardship is through the [Fritsche Lab](https://github.com/FritscheLab).
15+
1216
```mermaid
1317
flowchart TB
1418
accTitle: Eight-step GenAI coding workflow
@@ -43,3 +47,11 @@ flowchart TB
4347
- [Appendices](docs/index.md) collect recommended tools, prompt libraries, further reading, project plans, and references.
4448
- [Templates](docs/templates/index.md) provide reusable project plans, prompting examples, and an R script template.
4549
- [Scripts](scripts/index.md) documents the included synthetic EHR data simulation script.
50+
51+
## How to Cite
52+
53+
Please cite the guide as:
54+
55+
> Fritsche, Lars G. *Practical GenAI Coding Guide: A practical 8-step process for integrating GenAI tools into coding and research workflows*. Fritsche Lab, University of Michigan. https://FritscheLab.github.io/practical-genai-coding-guide/. Accessed YYYY-MM-DD.
56+
57+
Citation metadata is available in [CITATION.cff](CITATION.cff).

0 commit comments

Comments
 (0)