Skip to content

Commit

Permalink
Use project template from PennLINC.github.io.
Browse files Browse the repository at this point in the history
  • Loading branch information
tsalo committed Feb 27, 2024
1 parent cc657f8 commit 1ba3ff3
Showing 1 changed file with 81 additions and 2 deletions.
83 changes: 81 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,82 @@
# Project Name
---
layout: default
title: Project Template
parent: Documentation
has_children: false
has_toc: false
nav_order: 3
---

Documentation for the [Project Name] Project.

# Project Page Template

When you begin your project, use this template to fill out some critical information in the initial headers of your GitHub Pages site. Also see the [Project Setup page](https://pennlinc.github.io/docs/LabHome/ProjectSetup/).


### Project Title

Brief and informative title; not always the same as the manuscript title

### Brief Project Description

Try to make this no more than three highly accessible sentences.

### Project Lead(s)

Anticipated First Author(s)

### Faculty Lead(s)

Anticipated Last Author(s)

### Analytic Replicator

Team member who replicates analyses, as stipulated in the [Project Reproducibility Guide](https://pennlinc.github.io/docs/LabHome/ReproSystem/)

### Collaborators

Include people here as they make contributions (useful as our memory is imperfect and it is bad to forget contributions in long-running projects)

### Project Start Date

Date that project began

### Current Project Status

See the [Stages of a Project](https://pennlinc.github.io/docs/LabHome/ProjectStages/) page

### Dataset

E.g., PNC, HBN, GRMPY, etc

### Github repo

Link to github repository for the project

### Path to data on filesystem

Full path to project path on relevant computing cluster (i.e., CUBIC, PMACS, etc)

### Slack Channel

For project communication

### Trello board

For task tracking and keeping project meetings on track; provide link.

### Google Drive Folder

A good place to aggregate and share articles, manuscript drafts, etc; provide link.

### Zotero library

Shared library name for references

### Current work products

I.e., citations to poster presentations, links to preprints, final publication citation

### Code documentation

This section is the bulk of the project page, and can be broken up as best fits the project. Remember that this should be acessible prose that allows your replicator, reviewer, or interested reader to step through your code and understand how the code corresponds to the findings described in the paper. At a minimum, there should be clear documentation regarding sample selection (e.g., inclusion/exclusion), preprocessing (e.g., container version, data freeze), and hypothesis testing (usually in the form of an analytic notebook). See the [Project Reproducibility Guide](https://pennlinc.github.io/docs/LabHome/ReproSystem/) for more information.

0 comments on commit 1ba3ff3

Please sign in to comment.