Projects

Note

TODO : udpate project documentation (REAMDE?)

Project overview

NotePlanned

NoteWriting

NoteRevising

NoteUnder review

NotePublished

Project states

Projecs and can be in the following states:

flowchart LR
    subgraph Projects
        direction TB
        Concept(["Concept"]) -.-> Writing(["Writing"])
        Writing --> OnHold(["On hold"])
        OnHold --> Writing
        OnHold -.-> Abandoned(["Abandoned"])
        Writing ==> UnderReview(["Under review"])
        Revising -.-> OnHold
        Revising ==> UnderReview
        UnderReview ==> Revising(["Revising"])
        Revising ==> Published(["Published"])
    end
    style Projects fill:white,stroke:#333,stroke-width:3px

From ideas to projects

Ideas

• Research ideas should be formulated in relatively specific concept (markdown) files.
• Stored in a personal or shared repository (such as the work-hub).
• Yaml header:

---
status: concept
...
---

Summary of the idea (in Markdown)...

NoteExample: ideas

NeuroPoly

Selection

• Consider concepts with status: concept in personal or shared repositories (such as the work-hub).

Can be searched in Obsidian:

["status":concept]

• Consider fit with research areas
• Consider resources (current project workload, availability of collaborators etc.)

Creation

ResourceResource

• Projects are curated in the data/projects.yml.
• Pages are automatically generated here.
• All our research repositories on GitHub.

flowchart TB
  P["Project (umbrella)<br/>single entry in <code>data/projects.yml</code>"] --> N["Naming rule:<br/><b>&lt;project-acronym&gt;</b> is the prefix of all related repos<br/>(from <code>projects.yml</code>)"]

  N --> R1["<b>&lt;acronym&gt;</b>-paper<br/>(paper repo)"]
  N --> R2["<b>&lt;acronym&gt;</b>-data<br/>(dataset)"]
  N --> R3["<b>&lt;acronym&gt;</b>-software<br/>(software/package)"]
  N --> R4["<b>&lt;acronym&gt;</b>-materials<br/>(materials, slides, website)"]

  subgraph "Work continues here"
    direction TB
    R1
    R2
    R3
    R4
  end

Set up a repo setup

Project management

Access

To give access to a repository, navigate to the repository settings (collaborators).

Documentation

Notes on project management are added to the README.md file of the repository. Expected contributions can be specified using CRediT. The following can be used as a template:

Note

**Research project title (abbreviation)**

Target: Journal A, B

Contributors:

- Contributor A (initials): Conceptualization, Writing - original draft, Writing - review & editing, Supervision
- Contributor B (initials): Data Curation, Writing - review & editing

Instructions for [setup](link) and building the paper:

make pdf

## Log

Next steps:

- [ ] (initials): Taks A
- [ ] (initials): Task B

## CW1

- [X] Task C

Project status

To update the project status, change the status field in line with the project states. Add relevant project_history.