README.md 7.48 KB
Newer Older
1
# Data Catalogue
Emmanuel Raviart's avatar
Emmanuel Raviart committed
2
3
4
5
6
7

_Fetch, validate, convert & serve CESSDA-compliants DDI repositories._

## Installation

```bash
8
9
10
git clone https://git.nomics.world/progedo/data-catalogue.git
cd data-catalogue/
ln -s example.env .env
Emmanuel Raviart's avatar
Emmanuel Raviart committed
11
12
```

13
14
15
16
17
18
19
20
### Database Creation

#### Using _Debian GNU/Linux_

As `root` user:

```bash
apt install postgresql
David Smadja's avatar
David Smadja committed
21
apt install libpq-dev
22
23
24
25
26
27
28
29
30
31
32
33
34
35
su - postgres
psql
```

#### Using _MacOS_

```bash
brew install postgresql
psql postgres
```

#### For everybody

```sql
36
37
38
CREATE USER data_catalogue WITH PASSWORD 'data_catalogue';
CREATE DATABASE data_catalogue WITH OWNER data_catalogue;
\connect data_catalogue
39
40
41
42
43
CREATE EXTENSION IF NOT EXISTS pg_trgm;
\q
logout # For Debian only
```

44
As normal user, install dependencies:
45
46

```bash
David Smadja's avatar
David Smadja committed
47
npm install
48
49
```

50
51
52
As normal user, compile scripts to be able to use them:

```bash
53
npm run dist
54
55
```

56
57
58
As normal user, create database tables:

```bash
59
60
61
npm run configure
```

Emmanuel Raviart's avatar
Emmanuel Raviart committed
62
63
## Usage

64
65
66
### Fetching DDI Files

#### Fetching DDI Files from OAI-PMH Servers
Emmanuel Raviart's avatar
Emmanuel Raviart committed
67

Emmanuel Raviart's avatar
Emmanuel Raviart committed
68
```bash
69
# ADISP (OAI-PMH): Contains every french DDIs
70
node --experimental-specifier-resolution=node -- dist/scripts/retrieve_oai-pmh_ddis.js --url http://www.progedo-adisp.fr/oai/oai2.php ../public_data/adisp-oai-pmh-ddi/
71
72
73
74
75
76
```

#### Fetching DDI Files from Dataverse Servers

```bash
# data.sciencespo
77
node --experimental-specifier-resolution=node -- dist/scripts/retrieve_dataverse_ddis.js --url https://data.sciencespo.fr/ --verbose ../public_data/sciencespo-dataverse-ddi/
78
79
80
81
82
83
```

#### Fetching DDI Files from Nesstar Servers

```bash
# ADISP (public Nesstar) : Contains some French & English DDIs
84
node --experimental-specifier-resolution=node dist/scripts/retrieve_nesstar_ddis.js --url http://nesstar.progedo-adisp.fr/ ../public_data/adisp-nesstar-ddi/
85
# CDSP Sciences Po (obsolete & closed)
86
# node --experimental-specifier-resolution=node dist/scripts/retrieve_nesstar_ddis.js --url http://nesstar.sciences-po.fr/ ../public_data/cdsp-nesstar-ddi/
87
# INED
88
node --experimental-specifier-resolution=node dist/scripts/retrieve_nesstar_ddis.js --url http://nesstar.ined.fr/ ../public_data/ined-nesstar-ddi/
89
# INED - Generations and Gender Survey
90
node --experimental-specifier-resolution=node dist/scripts/retrieve_nesstar_ddis.js --url http://ggpsurvey.ined.fr/ ../public_data/ined-gpgsurvey-nesstar-ddi/
91
# UK Data Service
92
node --experimental-specifier-resolution=node dist/scripts/retrieve_nesstar_ddis.js --url http://nesstar.ukdataservice.ac.uk/ ../public_data/ukdataservice-nesstar-ddi/
93
# Norwegian Centre for Research Data
94
node --experimental-specifier-resolution=node dist/scripts/retrieve_nesstar_ddis.js --url http://nsddata.nsd.uib.no ../public_data/nsddata-nesstar-ddi/
95
96
```

97
### Repairing DDI Files
98
99

```bash
100
# ADISP
101
102
103
node --experimental-specifier-resolution=node dist/scripts/repair_adisp_oai-pmh_ddis.js --source=../public_data/adisp-oai-pmh-ddi/  ../public_data/adisp-oai-pmh-ddi-repaired/
node --experimental-specifier-resolution=node dist/scripts/repair_adisp_nesstar_ddis.js --source=../public_data/adisp-nesstar-ddi/  ../public_data/adisp-nesstar-ddi-repaired/
node --experimental-specifier-resolution=node dist/scripts/repair_ined_nesstar_ddis.js --source=../public_data/ined-nesstar-ddi/  ../public_data/ined-nesstar-ddi-repaired/
104
105
```

106
107
108
### Indexing DDI files

#### Indexing Progedo DDI Files
109
110

```bash
111
112
113
node --experimental-specifier-resolution=node -- dist/scripts/index_codebooks.js --language=fr --path=adisp ../public_data/adisp-oai-pmh-ddi-repaired/
node --experimental-specifier-resolution=node -- dist/scripts/index_codebooks.js --language=fr --path=cdsp ../public_data/sciencespo-dataverse-ddi/
node --experimental-specifier-resolution=node -- dist/scripts/index_codebooks.js --language=fr --path=ined ../public_data/ined-nesstar-ddi-repaired/
Emmanuel Raviart's avatar
Emmanuel Raviart committed
114
```
Emmanuel Raviart's avatar
Emmanuel Raviart committed
115

116
#### Indexing Other (non Progedo-related) DDI Files
117
118

```bash
119
120
node --experimental-specifier-resolution=node -- dist/scripts/index_codebooks.js --language=fr --path=adisp-nesstar ../public_data/adisp-nesstar-ddi-repaired/
node --experimental-specifier-resolution=node -- dist/scripts/index_codebooks.js --language=fr --path=cdsp ../public_data/sciencespo-dataverse-ddi/
121
# Obsolete
122
123
124
125
# node --experimental-specifier-resolution=node -- dist/scripts/index_codebooks.js --language=fr --path=cdsp-obsolete ../public_data/cdsp-nesstar-ddi/
node --experimental-specifier-resolution=node -- dist/scripts/index_codebooks.js --language=fr --path=ined/gpgsurvey ../public_data/ined-gpgsurvey-nesstar-ddi/
node --experimental-specifier-resolution=node -- dist/scripts/index_codebooks.js --language=en --path=ukdataservice ../public_data/ukdataservice-nesstar-ddi/
node --experimental-specifier-resolution=node -- dist/scripts/index_codebooks.js --language=no --path=nsddata ../public_data/nsddata-nesstar-ddi/
Emmanuel Raviart's avatar
Emmanuel Raviart committed
126

127
128
```

129
### Extracting Words from CodeBooks for Autocompletion
130
131

```bash
132
node --experimental-specifier-resolution=node -- dist/scripts/index_words.js
133
134
```

135
136
## Development

137
138
139
140
141
### Extracting TypeScript Raw Types from DDI Files

#### Extracting TypeScript Raw Types from Progedo DDI Files

```bash
142
node --experimental-specifier-resolution=node --max-old-space-size=10240 -- dist/scripts/raw_types_from_ddi_files.js ../public_data/adisp-oai-pmh-ddi-repaired/ ../public_data/sciencespo-dataverse-ddi/ ../public_data/ined-nesstar-ddi/
143

144
145
146
node --experimental-specifier-resolution=node --max-old-space-size=10240 -- dist/scripts/raw_types_from_ddi_files.js ../public_data/adisp-oai-pmh-ddi-repaired/ ../public_data/sciencespo-dataverse-ddi/ ../public_data/ined-nesstar-ddi/ --version=1.2.2
node --experimental-specifier-resolution=node --max-old-space-size=10240 -- dist/scripts/raw_types_from_ddi_files.js ../public_data/adisp-oai-pmh-ddi-repaired/ ../public_data/sciencespo-dataverse-ddi/ ../public_data/ined-nesstar-ddi/ --version=1.3
node --experimental-specifier-resolution=node --max-old-space-size=10240 -- dist/scripts/raw_types_from_ddi_files.js ../public_data/adisp-oai-pmh-ddi-repaired/ ../public_data/sciencespo-dataverse-ddi/ ../public_data/ined-nesstar-ddi/ --version=2.5
Emmanuel Raviart's avatar
Emmanuel Raviart committed
147

148
149
150
# Prettify generated TypeScript file:
npm run prettier
```
Emmanuel Raviart's avatar
Emmanuel Raviart committed
151

152
#### Extracting TypeScript Raw Types for Other Tests
153

Emmanuel Raviart's avatar
Emmanuel Raviart committed
154
```bash
155
156
157
158
node --experimental-specifier-resolution=node --max-old-space-size=8192 -- dist/scripts/raw_types_from_ddi_files.js ../public_data/adisp-manual-ddi/ --target=src/raw_types/codebooks_adisp_manual.ts
node --experimental-specifier-resolution=node --max-old-space-size=8192 -- dist/scripts/raw_types_from_ddi_files.js ../public_data/adisp-nesstar-ddi/ --target=src/raw_types/codebooks_adisp_nesstar.ts
node --experimental-specifier-resolution=node -- dist/scripts/raw_types_from_ddi_files.js ../public_data/sciencespo-dataverse-ddi/ --target=src/raw_types/codebooks_sciencespo_dataverse.ts
node --experimental-specifier-resolution=node -- dist/scripts/raw_types_from_ddi_files.js ../public_data/ined-nesstar-ddi/ --target=src/raw_types/codebooks_ined_nesstar.ts
Emmanuel Raviart's avatar
Emmanuel Raviart committed
159
160
161
162

# Prettify generated TypeScript files:
npm run prettier
```
163
164
165
166
167
168
169
170
171
172
173
174

### Generating a CSV file of all organizations

```sql
COPY (
  SELECT name, acronym, relation
  FROM organizations
  INNER JOIN study_organization_associations
    ON organizations.name = study_organization_associations.organization_name
  GROUP BY name, acronym, relation
  ORDER BY name, relation
) TO '/tmp/organizations.csv' DELIMITER ',' CSV HEADER;
175
176
177
178
179
180
181
182
183

COPY (
  SELECT name, acronym, relation, study_path
  FROM organizations
  INNER JOIN study_organization_associations
    ON organizations.name = study_organization_associations.organization_name
  GROUP BY name, acronym, relation, study_path
  ORDER BY name, relation
) TO '/tmp/organizations_with_studies.csv' DELIMITER ',' CSV HEADER;
184
```