Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
JacMatu authored Mar 20, 2024
0 parents commit 08419f3
Show file tree
Hide file tree
Showing 48 changed files with 2,018 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .datalad/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
config annex.largefiles=nothing
metadata/aggregate* annex.largefiles=nothing
metadata/objects/** annex.largefiles=(anything)
2 changes: 2 additions & 0 deletions .datalad/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[datalad "dataset"]
id = 32a6f625-e2f0-4df9-a563-858a90ded00f
9 changes: 9 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
* annex.backend=MD5E
**/.git* annex.largefiles=nothing

.github/workflows/* annex.largefiles=nothing
.github/* annex.largefiles=nothing

*.yaml annex.largefiles=nothing
*.md annex.largefiles=nothing
*.sh annex.largefiles=nothing
14 changes: 14 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

# Documentation
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
version: 2
updates:
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: 'monthly'

- package-ecosystem: 'gitsubmodule'
directory: '/'
schedule:
interval: 'monthly'
38 changes: 38 additions & 0 deletions .github/workflows/miss_hit_quality.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: miss_hit_quality

on:
push:
branches:
- main
pull_request:
branches: ['*']

jobs:
build:

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v4
with:
submodules: false
fetch-depth: 1

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"

- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools
pip3 install -r code/requirements.txt
- name: MISS_HIT Metrics
run: |
mh_metric --ci
- name: MISS_HIT Bug finder
run: |
mh_lint
34 changes: 34 additions & 0 deletions .github/workflows/miss_hit_style.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: miss_hit_style

on:
push:
branches:
- main
pull_request:
branches: ['*']

jobs:
build:

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v4
with:
submodules: false
fetch-depth: 1

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"

- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools
pip3 install -r code/requirements.txt
- name: MISS_HIT Code style
run: |
mh_style
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*DS_Store
.vscode
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "code/lib/bidspm"]
path = code/lib/bidspm
url = https://github.com/cpp-lln-lab/bidspm.git
34 changes: 34 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
repos:
- repo: local

hooks:
- id: mh_style
name: mh_style
entry: mh_style
args: [--process-slx, --fix]
files: ^(.*\.(m|slx))$
language: python
additional_dependencies: [miss_hit_core]

- id: mh_metric
name: mh_metric
entry: mh_metric
args: [--ci]
files: ^(.*\.(m|slx))$
language: python
additional_dependencies: [miss_hit_core]

- id: mh_lint
name: mh_lint
entry: mh_lint
files: ^(.*\.(m|slx))$
language: python
additional_dependencies: [miss_hit]

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
Empty file added CHANGELOG.md
Empty file.
93 changes: 93 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
[![made-with-datalad](https://www.datalad.org/badges/made_with.svg)](https://datalad.org)

# Project <insert name>

This repo is made with
[cpp-lln-lab/template_datalad_fMRI](https://github.com/cpp-lln-lab/template_datalad_fMRI).

[⚠️ CHECK THE GUIDE ON HOW TO USE IT ⚠️](./how-to-use-me.md)

## Add below documentation regarding this project

## DataLad datasets and how to use them

<!-- BELOW IS THE TEMPLATE README FOR DATALAD DATASET
MODIFY AT WILL
-->

This repository is a [DataLad](https://www.datalad.org/) dataset. It provides
fine-grained data access down to the level of individual files, and allows for
tracking future updates. In order to use this repository for data retrieval,
[DataLad](https://www.datalad.org/) is required. It is a free and open source
command line tool, available for all major operating systems, and builds up on
Git and [git-annex](https://git-annex.branchable.com/) to allow sharing,
synchronizing, and version controlling collections of large files. You can find
information on how to install DataLad at
[handbook.datalad.org/en/latest/intro/installation.html](http://handbook.datalad.org/en/latest/intro/installation.html).

### Get the dataset

A DataLad dataset can be `cloned` by running

```
datalad install <url>
```

Once a dataset is cloned, it is a light-weight directory on your local machine.
At this point, it contains only small metadata and information on the identity
of the files in the dataset, but not actual _content_ of the (sometimes large)
data files.

### Retrieve dataset content

After cloning a dataset, you can retrieve file contents by running

```
datalad get <path/to/directory/or/file>`
```

This command will trigger a download of the files, directories, or subdatasets
you have specified.

DataLad datasets can contain other datasets, so called _subdatasets_. If you
clone the top-level dataset, subdatasets do not yet contain metadata and
information on the identity of files, but appear to be empty directories. In
order to retrieve file availability metadata in subdatasets, run

```
datalad get -n <path/to/subdataset>
```

Afterwards, you can browse the retrieved metadata to find out about subdataset
contents, and retrieve individual files with `datalad get`. If you use
`datalad get <path/to/subdataset>`, all contents of the subdataset will be
downloaded at once.

### Stay up-to-date

DataLad datasets can be updated. The command `datalad update` will _fetch_
updates and store them on a different branch (by default
`remotes/origin/master`). Running

```
datalad update --merge
```

will _pull_ available updates and integrate them in one go.

### Find out what has been done

DataLad datasets contain their history in the `git log`. By running `git log`
(or a tool that displays Git history) in the dataset or on specific files, you
can find out what has been done to the dataset or to individual files by whom,
and when.

### More information

More information on DataLad and how to use it can be found in the DataLad
Handbook at
[handbook.datalad.org](http://handbook.datalad.org/en/latest/index.html). The
chapter "DataLad datasets" can help you to familiarize yourself with the concept
of a dataset.
1 change: 1 addition & 0 deletions code/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* annex.largefiles=nothing
35 changes: 35 additions & 0 deletions code/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# exclude content of logfiles folders
*.tsv
*.mat

# Windows default autosave extension
*.asv

# OSX / *nix default autosave extension
*.m~

# Compiled MEX binaries (all platforms)
*.mex*

# Packaged app and toolbox files
*.mlappinstall
*.mltbx

# Generated helpsearch folders
helpsearch*/

# Simulink code generation folders
slprj/
sccprj/

# Matlab code generation folders
codegen/

# Simulink autosave extension
*.autosave

# Simulink cache files
*.slxc

# Octave session info
octave-workspace
Loading

0 comments on commit 08419f3

Please sign in to comment.