Skip to content

Commit 41d2eba

Browse files
authored
Merge pull request #481 from Remi-Gau/patch-2
[MAINT] ensures precommit is run on master
2 parents e81d9aa + 09d47a7 commit 41d2eba

10 files changed

+22
-29
lines changed

.github/workflows/run_precommit.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: pre-commit
44
on:
55
pull_request:
66
push:
7-
branches: [main]
7+
branches: [master]
88

99
jobs:
1010
pre-commit:

docs/30_schema.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ src="../img/reproschema.png"
2121
alt="reproschema"
2222
style="width: 800px; height: auto; display: block; margin-left: auto; margin-right: auto;"/>
2323

24-
You can see an example of those in the [examples folder](https://github.com/ReproNim/reproschema/examples)
24+
You can see an example of those in the [examples folder](https://github.com/ReproNim/reproschema/tree/master/examples)
2525

2626
There are in fact more levels than this each and each level has its own schema:
27-
- all of the schemas can be found in the [`terms` folder](https://github.com/ReproNim/reproschema/terms)
28-
- the Reproschema actually allows for a more complex level nesting than the one described above (e.g you can have an `activity` wihtin an `activity`)
27+
- all of the schemas can be found in the [`terms` folder](https://github.com/ReproNim/reproschema/tree/master/terms)
28+
- the Reproschema actually allows for a more complex level nesting than the one described above (e.g you can have an `activity` within an `activity`)
2929
- all the properties of each level are described below in the [Properties of ReproSchema objects section](#properties-of-reproschema-objects)
3030

3131
## Detailed description

docs/50_using_reproschema.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For this tutorial you will be using some other tools to put your work online. He
1818
We don't assume that you have in-depth knowledge of Git and Github for this tutorial so we will try to provide with the commands you need to type when it is required. Similarly, we will provide some of the commands to create directories and files though you could do many of those actions "by hand" with a couple of mouse clicks.
1919

2020
??? "For Windows users"
21-
Most of the commands we will provide should work in the command line interface that will come on your computer when you isntall Git. But you could also look into using one the linux sub-system that provide you with Unix command line and that can be easily installed from the app-store on your computer.
21+
Most of the commands we will provide should work in the command line interface that will come on your computer when you install Git. But you could also look into using one the linux sub-system that provide you with Unix command line and that can be easily installed from the app-store on your computer.
2222

2323
## Context
2424

@@ -35,7 +35,7 @@ So we would want to have a set of questionnaires:
3535

3636
We will be creating several jsonld files in this tutorial. Those can quickly grow big and it can be hard to see what was added to a certain file from one step to the next. This gets even more confusing when you know that the order of the lines does not really matter. So to makes things easier to follow (and unless we explicitly say so) any new content we add to a file we have already worked on will be put at the end of this file.
3737

38-
So if step 1 looked like this:
38+
So if step 1 looked like this:
3939

4040
```json
4141
{
@@ -82,4 +82,4 @@ Although some other possibility would be equivalent:
8282
"schemaVersion": "1.0.0",
8383
"version": "0.0.1",
8484
}
85-
```
85+
```

docs/51_create_new_protocol.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ We first need to create some folders to host the schema that will represent all
99
```bash
1010
# Type this in a terminal window
1111

12-
# FYI: this line starts with #
12+
# FYI: this line starts with #
1313
# it is comment and it will not be executed
1414
# if you copy paste it in the command line
1515

@@ -168,21 +168,21 @@ Let's just highlight the things that have changed.
168168

169169
We have added a `ui` and an `order` fields.
170170

171-
`ui` is for things realted to the user interface and contains `addProperties` where we will be listing all the assessments that we add to our protocol.
171+
`ui` is for things related to the user interface and contains `addProperties` where we will be listing all the assessments that we add to our protocol.
172172

173173
Each assessment is represented by an activity that is given a `variableName` and a `prefLabel`. The latter will be used as the name to display on the UI in english.
174174

175-
The field `isAbout` is the URL to point to the schema of that activity.
175+
The field `isAbout` is the URL to point to the schema of that activity.
176176

177177
The field `order` is there to indicate which activity should be presented first, second...
178178

179179
??? "Making sure you have a valid json file"
180-
Json files can get a bit long and you might sometimes forget a coma of a closing square brackets, so to make sure that your json file is correctly formatted you can use a linter. For example, you can test individual files on the [json linter website](`https://jsonlint.com/`).
180+
Json files can get a bit long and you might sometimes forget a coma of a closing square brackets, so to make sure that your json file is correctly formatted you can use a linter. For example, you can test individual files on the [json linter website](https://jsonlint.com/).
181181

182182
??? "JSON-LD expansion"
183183
You might notice that `rl:PHQ-9/PHQ9_schema` does not look like a typical URL and clearly does not match the one we fed the UI earlier (https://raw.githubusercontent.com/ReproNim/reproschema-library/master/activities/PHQ-9/PHQ9_schema). Well this is because we have defined, in the `@context` part of our jsonld, that the `rl` from `rl:PHQ-9/PHQ9_schema` will actually stand for `https://raw.githubusercontent.com/ReproNim/reproschema-library/master/activities/`. This shorthand makes it faster for us to write URL but the UI will know how to `expand` this into an actual URL.
184-
185-
Similarly the `reproschema:Protocol` in `"@type": "reproschema:Protocol"` expands in `http://schema.repronim.org/Protocol` because `reproschema` has been indirectly defined in the context of `depression_nimg_schema.jsonld`. To be more precise `reproschema` is defined in the [base file](https://raw.githubusercontent.com/ReproNim/reproschema/1.0.0-rc1/contexts/base) which is part of the context of the [generic file](https://raw.githubusercontent.com/ReproNim/reproschema/1.0.0-rc1/contexts/generic) that our protocol points to.
184+
185+
Similarly the `reproschema:Protocol` in `"@type": "reproschema:Protocol"` expands in `http://schema.repronim.org/Protocol` because `reproschema` has been indirectly defined in the context of `depression_nimg_schema.jsonld`. To be more precise `reproschema` is defined in the [base file](https://raw.githubusercontent.com/ReproNim/reproschema/1.0.0-rc1/contexts/base) which is part of the context of the [generic file](https://raw.githubusercontent.com/ReproNim/reproschema/1.0.0-rc1/contexts/generic) that our protocol points to.
186186

187187

188188

@@ -254,5 +254,3 @@ git add --all
254254
git commit -m 'add a thank you activity'
255255
git push
256256
```
257-
258-

docs/53_tips_to_make_your_life_easier.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ grep -r "@context" . \
1515
| cut -d: -f1 | xargs -I fname jsonlint -q fname
1616
```
1717

18-
Or test individual files on the [json linter website](`https://jsonlint.com/`).
18+
Or test individual files on the [json linter website](https://jsonlint.com/).
1919

2020
## Validating your schema
2121

@@ -45,7 +45,7 @@ every time there some new content is added on a repository.
4545
To set those up you simply need to create a `.github/workflows` folder inside
4646
the repository where you are working. This will contain all the workflows (a set
4747
of "actions") that Github has to run on this repository. Each workflow is
48-
decribed by a `yml` file.
48+
described by a `yml` file.
4949

5050
<!-- TODO
5151
- add link to the turing-way section on yml files.

docs/54_translating_an_activity.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Well there is an easy way to reuse the work we have already done to have the too
77
First here is the list of the questions of the EHI in French.
88

99
```
10-
Quelle main utilisez vous de préférence pour:
10+
Quelle main utilisez vous de préférence pour:
1111
1212
1) Écrire (*)
1313
2) Dessiner
@@ -208,5 +208,3 @@ We need to update the `edinburgh_handedness_inventory_short.jsonld` so that the
208208
"fr": "Quelle main utilisez vous de préférence pour :"
209209
}
210210
```
211-
212-

docs/55_collecting_demographics_information.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Collecting information about your participant
22

3-
Before you go and start creating new activities and items to collect the names, surnames and other demographics of your participants make sure you have had a look at these items on the reproschema library:
3+
Before you go and start creating new activities and items to collect the names, surnames and other demographics of your participants make sure you have had a look at these items on the reproschema library:
44

55
See the [demographics_and_background_information_v1](https://github.com/ReproNim/reproschema-library/tree/master/activities/demographics_and_background_information_v1/items) folder:
66

@@ -146,6 +146,3 @@ demographics_and_background_information_v1/
146146
}
147147
}
148148
```
149-
150-
151-

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ could save you from a lot of confusion. 😉
1919
- Not sure how the project is organized? Check out the [project structure](./20_project_structure.md)
2020
page.
2121

22-
- Want more details on how the `Reproschema` itself is structured: check out our [schema page](./30_schema)
22+
- Want more details on how the `Reproschema` itself is structured: check out our [schema page](./30_schema.md)
2323

2424
<!-- - If you want to use the schema to create your own questionnaire: check out our
2525

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ nav:
2828
- Toolkit: "46_tools.md"
2929
- Tutorial:
3030
- Intro: "50_using_reproschema.md"
31-
- Create a research protocol: "51_create_new_protocol.md"
31+
- Create a research protocol: "51_create_new_protocol.md"
3232
- Creating a new activity: "52_create_new_activity.md"
3333
- Tips to make your life easier: "53_tips_to_make_your_life_easier.md"
3434
- Translate a questionnaire: "54_translating_an_activity.md"
@@ -55,4 +55,4 @@ markdown_extensions:
5555
pygments_lang_class: true
5656
- pymdownx.inlinehilite
5757
- pymdownx.snippets
58-
- pymdownx.superfences
58+
- pymdownx.superfences

mlc_config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{"pattern": "http://127.0.0.1:8000/"},
44
{"pattern": "^https://jsonformatter.curiousconcept.com/"},
55
{"pattern": "^http.*://schema.repronim.org/.*"},
6-
{"pattern": "^http://schema.org/version/2.0/"}
7-
6+
{"pattern": "^http://schema.org/version/2.0/"},
7+
{"pattern": "^https://doi.org/10.1080/1357650X.2013.783045"}
88
]
99
}

0 commit comments

Comments
 (0)