Writing QuNex Tutorials - ULJ-Yale/qunexsdk GitHub Wiki

This page outlines how to share QuNex tutorials online using the provided template on platforms like personal blogs and websites.

The Template

The text below is the suggested template for tutorial posts.

Title

Author: Affiliation: Correspondence:

Add a short, one-paragraph overview of the content of the tutorial.


1. Introduction

The introduction should include a brief overview of the scientific background, followed by the problem identification and the description of aims and goals of the tutorial (e.g. 1-3 paragraphs).

2. Data and Tools

This section should provide data information, such as basic demographic information of participants included in the data set, the types of data collected (e.g. behavioral, fMRI, EEG), and any details of data collection relevant to the purpose of the tutorial. Here, you should also describe any software needed to conduct the tutorial (e.g. 1-3 paragraphs).

3. Methods and Results

This section should present different steps of data analysis with relevant examples and results. For example, you should provide the specifics of the used commands (i.e. inputs, settings) and describe results obtained using these commands (i.e. outputs, quality control). The section can be subdivided into subsections if relevant.

Here, you can find some useful Markdown formatting for code, images, and web links:

  • code references in the text: qunex -a

  • larger code snippets:

qunex_container hcp_pre_freesurfer \
  --sessionsfolder="$study/sessions" \
  --sessions="$study/processing/batch_hcp.txt" \
  --overwrite="no" \
  --nprocess="0" \
  --cores=1 \
  --container="$qunex_container_path" \
  --test

3.1. Subsection 1

3.2. Subsection 2

3.3. Subsection 3

4. Summary

The conclusion should summarize the main goal and results of the tutorial, in addition to discussing any limitations of the presented method and potential further developments and applications (e.g. 1-3 paragraphs).

5. References

References should follow the latest American Psychology Association (APA) standards.

Published: dd-mm-yyyy Last update: dd-mm-yyyy