README.md 8.09 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
As normal user, compile scripts and server middlewares to be able to use them:
51
52

```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

Emmanuel Raviart's avatar
0.21.0    
Emmanuel Raviart committed
64
65
66
### Updating database when drop-box directory change

```bash
67
node --experimental-specifier-resolution=node -- package/scripts/update_ddis_on_directory_changes.js --output ../public_data/ --verbose adisp
Emmanuel Raviart's avatar
0.21.0    
Emmanuel Raviart committed
68
69
```

70
71
72
### Fetching DDI Files

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

Emmanuel Raviart's avatar
Emmanuel Raviart committed
74
```bash
75
# ADISP (OAI-PMH): Contains every french DDIs
Emmanuel Raviart's avatar
Emmanuel Raviart committed
76
# node --experimental-specifier-resolution=node -- package/scripts/retrieve_oai-pmh_ddis.js --url http://www.progedo-adisp.fr/oai/oai2.php ../public_data/adisp-oai-pmh-ddi/
77
78
79
80
81
82
```

#### Fetching DDI Files from Dataverse Servers

```bash
# data.sciencespo
83
node --experimental-specifier-resolution=node -- package/scripts/retrieve_dataverse_ddis.js --tree cdsp --url https://data.sciencespo.fr/ --verbose ../public_data/sciencespo-dataverse-ddi/
84
85
86
87
88
89
```

#### Fetching DDI Files from Nesstar Servers

```bash
# ADISP (public Nesstar) : Contains some French & English DDIs
Emmanuel Raviart's avatar
Emmanuel Raviart committed
90
# node --experimental-specifier-resolution=node package/scripts/retrieve_nesstar_ddis.js --url http://nesstar.progedo-adisp.fr/ ../public_data/adisp-nesstar-ddi/
91
# CDSP Sciences Po (obsolete & closed)
92
# node --experimental-specifier-resolution=node package/scripts/retrieve_nesstar_ddis.js --url http://nesstar.sciences-po.fr/ ../public_data/cdsp-nesstar-ddi/
93
# INED
Emmanuel Raviart's avatar
Emmanuel Raviart committed
94
# node --experimental-specifier-resolution=node package/scripts/retrieve_nesstar_ddis.js --url http://nesstar.ined.fr/ ../public_data/ined-nesstar-ddi/
95
# INED - Generations and Gender Survey
96
node --experimental-specifier-resolution=node package/scripts/retrieve_nesstar_ddis.js --url http://ggpsurvey.ined.fr/ ../public_data/ined-gpgsurvey-nesstar-ddi/
97
# UK Data Service
98
node --experimental-specifier-resolution=node package/scripts/retrieve_nesstar_ddis.js --url http://nesstar.ukdataservice.ac.uk/ ../public_data/ukdataservice-nesstar-ddi/
99
# Norwegian Centre for Research Data
100
node --experimental-specifier-resolution=node package/scripts/retrieve_nesstar_ddis.js --url http://nsddata.nsd.uib.no ../public_data/nsddata-nesstar-ddi/
101
102
```

103
### Repairing DDI Files
104
105

```bash
106
# ADISP
107
108
node --experimental-specifier-resolution=node package/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 package/scripts/repair_adisp_nesstar_ddis.js --source=../public_data/adisp-nesstar-ddi/ ../public_data/adisp-nesstar-ddi-repaired/
Emmanuel Raviart's avatar
Emmanuel Raviart committed
109
# node --experimental-specifier-resolution=node package/scripts/repair_ined_nesstar_ddis.js --source=../public_data/ined-nesstar-ddi/ ../public_data/ined-nesstar-ddi-repaired/
110
111
```

112
113
114
### Indexing DDI files

#### Indexing Progedo DDI Files
115
116

```bash
117
118
119
# node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=fr --path=adisp ../public_data/adisp-oai-pmh-ddi-repaired/
node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=fr --path=adisp ../public_data/adisp-ddis-repaired/
node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=fr --path=cdsp ../public_data/sciencespo-dataverse-ddi/
120
121
# node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=fr --path=ined ../public_data/ined-nesstar-ddi-repaired/
node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=fr --path=ined ../public_data/ined-manual-ddi/
Emmanuel Raviart's avatar
Emmanuel Raviart committed
122
```
Emmanuel Raviart's avatar
Emmanuel Raviart committed
123

124
#### Indexing Other (non Progedo-related) DDI Files
125
126

```bash
127
128
node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=fr --path=adisp-nesstar ../public_data/adisp-nesstar-ddi-repaired/
node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=fr --path=cdsp ../public_data/sciencespo-dataverse-ddi/
129
# Obsolete
130
131
132
133
# node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=fr --path=cdsp-obsolete ../public_data/cdsp-nesstar-ddi/
node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=fr --path=ined/gpgsurvey ../public_data/ined-gpgsurvey-nesstar-ddi/
node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=en --path=ukdataservice ../public_data/ukdataservice-nesstar-ddi/
node --experimental-specifier-resolution=node -- package/scripts/index_codebooks.js --language=no --path=nsddata ../public_data/nsddata-nesstar-ddi/
Emmanuel Raviart's avatar
Emmanuel Raviart committed
134

135
136
```

137
### Extracting Words from CodeBooks for Autocompletion
138
139

```bash
140
node --experimental-specifier-resolution=node -- package/scripts/index_words.js
141
142
```

143
144
## Development

145
146
147
148
149
### Extracting TypeScript Raw Types from DDI Files

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

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

152
153
154
node --experimental-specifier-resolution=node --max-old-space-size=10240 -- package/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 -- package/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 -- package/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
155

156
157
158
# Prettify generated TypeScript file:
npm run prettier
```
Emmanuel Raviart's avatar
Emmanuel Raviart committed
159

160
#### Extracting TypeScript Raw Types for Other Tests
161

Emmanuel Raviart's avatar
Emmanuel Raviart committed
162
```bash
163
164
165
166
node --experimental-specifier-resolution=node --max-old-space-size=8192 -- package/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 -- package/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 -- package/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 -- package/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
167
168
169
170

# Prettify generated TypeScript files:
npm run prettier
```
171
172
173
174
175
176
177
178
179
180
181
182

### 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;
183
184
185
186
187
188
189
190
191

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;
192
```