analysis.md 5.6 KB
Newer Older
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
1
---
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
2
layout: default
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
3
4
title: Open Analysis
parent: Open WIN Tools
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
5
has_children: false
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
6
7
8
9
10
11
12
13
14
15
16
17
18
nav_order: 3
---



# Open Analysis
{: .fs-9 }

How to share reproducible FSL analysis pipelines
{: .fs-6 .fw-300 }

---

Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
19
![open-analysis](../../../img/img-open-anal-flow.png)
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

## Purpose

The Open Analysis Working Group has worked with researchers to capture details of the magnetic resonance imaging (MRI) tools that they use in data processing. WIN is the developmental home of the popular [FMRIB Software Library (FSL)](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/) MRI analysis package, which has been free to all users since its inception. FSL this is the tool of choice for most WIN researchers. The Working Group has devised a processes which researchers can slot into their normal FSL usage to ensure their analysis is reproducible and can be easily shared with others.

### Data standards for interoperable code
International community data standards - specifically the [Brain Imaging Data Structure (BIDS)](https://bids.neuroimaging.io) - have been employed to ensure that shared pipelines are compatible with tools developed elsewhere. This working group is also committed to actively engaging with the future development of BIDS, to ensure lifetime compatibility between FSL and the wide data standards.

### Education
Another large focus of this working group is developing programming literacy among WIN members, to support users in creating robust code to run their analysis. Significant efforts have been made to update the [FSL training material](https://fsl.fmrib.ox.ac.uk/fslcourse/), which is now available for free both internally and externally, and has been updated to include basic training in Unix command line access. The FSL course is being run remotely and at reduced registration rates for the first time in 2020, for improved accessibility and inclusivity.

Coming soon
{: .label .label-yellow }

**THIS TOOL IS CURRENTLY IN DEVELOPMENT. PLEASE REFER TO THE INFORMATION BELOW TO UNDERSTAND THE AIM AND AMBITION OF THIS PROJECT. THE "HOW TO" GUIDE WILL BE BUILT BY THE COMMUNITY AND TOOL DEVELOPERS IN THE COMING MONTHS.**    

<br>

Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
38
[![For WIN members](../../../img/btn-win.png)](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/tools/analysis/#for-win-members)      [![For external researchers](../../../img/btn-external.png)](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/tools/analysis/#for-external-researchers)
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
39
40

## For WIN members
41
### Benefits
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
42
#### Version control ![version-control](../../../img/icon-version-control.png)
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
43
WIN members will be encouraged to develop their analysis pipelines into standalone scripts and store these on the [WIN GitLab instance](https://git.fmrib.ox.ac.uk). We will support our members in using git to version control their code, and employ best practice in ensuring their pipelines are robust and accurate. Find out more about [using GitLab](../../gitlab)
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
44

Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
45
#### Citable research output ![doi](../../../img/icon-doi.png)
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
46
Versions of analysis code can be assigned a digital object identified (DOI) using [Zenodo](https://zenodo.org) by uploading them from GitLab. Once a DOI has been created, your analysis code becomes a citable object which you can add to your list of research outputs. Find out how to [create a doi for your repository](../../gitlab/4-2-you-doi).
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
47

Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
48
#### Reproducible methods detail ![reproduce](../../../img/icon-reproduce.png)
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
49
Alongside your analysis code, WIN members will be supported in implementing a "[wrapper](https://techterms.com/definition/wrapper)" script which can:
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
50
1. access data stored on the WIN [Open Data](../data) servers;
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
51
52
53
54
55
56
57
58
59
60
2. access your GitLab code repository;
3. pull a stable version of the FSL analysis package in a [Singularity container](https://en.wikipedia.org/wiki/Singularity_(software));
4. Run the accessed data using the supplied code and the given version of FSL via the container on a high performance cluster.

The benefit of the above comes from version control of the singularity container and that it encompasses a complete computational environment, such that it can be run on any operating system without concern over dependencies of versions of packages, making the analysis highly reproducible.

## For external researchers
External users will be able to access the shared code and singularity containers, along with data when this is shared openly, and repeat the analysis to probe the results. External users will also be able to modify shared analysis code to suit there own needs, where this is shared with a permissive license.

## How to use
61
#### Analysis wrapper
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
62
63
64
Coming soon
{: .label .label-yellow }

Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
65
Detailed guidance on how to use the Open Analysis wrapper will be produced during one of our [documentation hacks](../../events/doc-hack-1)
66
67

#### Repository template
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
68
You are free to include whatever material you wish in your repository. We have created this [guide on what to include](../../gitlab/repo-include) to list some of the pages and sections which may be beneficial for readers. See also our guide on [how to license](../../gitlab/repo-license) your material.
69
70

#### Creating a doi
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
71
We recommend using zenodo to create a doi for your material. See see the [creating a doi](../../gitlab/repo-doi) page for instructions.
Cassandra Gould van Praag's avatar
Cassandra Gould van Praag committed
72
73
74
75
76
77
78
79

## Working group members (alphabetically)
We are grateful to the following WIN members for their contributions to developing the Open Analysis tools
- [Taylor Hanayik](https://www.win.ox.ac.uk/people/taylor-hanayik)
- [Mark Jenkinson](https://www.win.ox.ac.uk/people/mark-jenkinson)
- Paul McCarthy
- [Andrew Quinn](https://www.win.ox.ac.uk/people/andrew-quinn)
- [Matthew Webster](https://www.win.ox.ac.uk/people/matthew-webster)