README.md 7 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
```

David Smadja's avatar
David Smadja committed
44
As normal user, install dependencies and create database tables:
45
46

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

Emmanuel Raviart's avatar
Emmanuel Raviart committed
51
52
## Usage

53
54
55
### Fetching DDI Files

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

Emmanuel Raviart's avatar
Emmanuel Raviart committed
57
```bash
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# ADISP (OAI-PMH): Contains every french DDIs
npx babel-node --extensions ".ts" -- src/scripts/retrieve_oai-pmh_ddis.ts --url http://www.progedo-adisp.fr/oai/oai2.php ../public_data/adisp-oai-pmh-ddi/
```

#### Fetching DDI Files from Dataverse Servers

```bash
# data.sciencespo
npx babel-node --extensions ".ts" -- src/scripts/retrieve_dataverse_ddis.ts --url https://data.sciencespo.fr/ --verbose ../public_data/sciencespo-dataverse-ddi/
```

#### Fetching DDI Files from Nesstar Servers

```bash
# ADISP (public Nesstar) : Contains some French & English DDIs
npx babel-node --extensions ".ts" src/scripts/retrieve_nesstar_ddis.ts --url http://nesstar.progedo-adisp.fr/ ../public_data/adisp-nesstar-ddi/
74
# CDSP Sciences Po (obsolete & closed)
75
# npx babel-node --extensions ".ts" src/scripts/retrieve_nesstar_ddis.ts --url http://nesstar.sciences-po.fr/ ../public_data/cdsp-nesstar-ddi/
76
# INED
77
npx babel-node --extensions ".ts" src/scripts/retrieve_nesstar_ddis.ts --url http://nesstar.ined.fr/ ../public_data/ined-nesstar-ddi/
78
# INED - Generations and Gender Survey
79
npx babel-node --extensions ".ts" src/scripts/retrieve_nesstar_ddis.ts --url http://ggpsurvey.ined.fr/ ../public_data/ined-gpgsurvey-nesstar-ddi/
80
# UK Data Service
81
npx babel-node --extensions ".ts" src/scripts/retrieve_nesstar_ddis.ts --url http://nesstar.ukdataservice.ac.uk/ ../public_data/ukdataservice-nesstar-ddi/
82
# Norwegian Centre for Research Data
83
npx babel-node --extensions ".ts" src/scripts/retrieve_nesstar_ddis.ts --url http://nsddata.nsd.uib.no ../public_data/nsddata-nesstar-ddi/
84
85
```

86
### Repairing DDI Files
87
88

```bash
89
# ADISP
Emmanuel Raviart's avatar
Emmanuel Raviart committed
90
91
npx babel-node --extensions ".ts" src/scripts/repair_adisp_oai-pmh_ddis.ts --source=../public_data/adisp-oai-pmh-ddi/  ../public_data/adisp-oai-pmh-ddi-repaired/
npx babel-node --extensions ".ts" src/scripts/repair_adisp_nesstar_ddis.ts --source=../public_data/adisp-nesstar-ddi/  ../public_data/adisp-nesstar-ddi-repaired/
92
npx babel-node --extensions ".ts" src/scripts/repair_ined_nesstar_ddis.ts --source=../public_data/ined-nesstar-ddi/  ../public_data/ined-nesstar-ddi-repaired/
93
94
```

95
96
97
### Indexing DDI files

#### Indexing Progedo DDI Files
98
99

```bash
100
npx babel-node --extensions ".ts" -- src/scripts/index_codebooks.ts --language=fr --path=adisp ../public_data/adisp-oai-pmh-ddi-repaired/
Emmanuel Raviart's avatar
Emmanuel Raviart committed
101
npx babel-node --extensions ".ts" -- src/scripts/index_codebooks.ts --language=fr --path=cdsp ../public_data/sciencespo-dataverse-ddi/
102
npx babel-node --extensions ".ts" -- src/scripts/index_codebooks.ts --language=fr --path=ined ../public_data/ined-nesstar-ddi-repaired/
Emmanuel Raviart's avatar
Emmanuel Raviart committed
103
```
Emmanuel Raviart's avatar
Emmanuel Raviart committed
104

105
#### Indexing Other (non Progedo-related) DDI Files
106
107

```bash
108
109
110
111
112
113
114
npx babel-node --extensions ".ts" -- src/scripts/index_codebooks.ts --language=fr --path=adisp-nesstar ../public_data/adisp-nesstar-ddi-repaired/
npx babel-node --extensions ".ts" -- src/scripts/index_codebooks.ts --language=fr --path=cdsp ../public_data/sciencespo-dataverse-ddi/
# Obsolete
# npx babel-node --extensions ".ts" -- src/scripts/index_codebooks.ts --language=fr --path=cdsp-obsolete ../public_data/cdsp-nesstar-ddi/
npx babel-node --extensions ".ts" -- src/scripts/index_codebooks.ts --language=fr --path=ined/gpgsurvey ../public_data/ined-gpgsurvey-nesstar-ddi/
npx babel-node --extensions ".ts" -- src/scripts/index_codebooks.ts --language=en --path=ukdataservice ../public_data/ukdataservice-nesstar-ddi/
npx babel-node --extensions ".ts" -- src/scripts/index_codebooks.ts --language=no --path=nsddata ../public_data/nsddata-nesstar-ddi/
Emmanuel Raviart's avatar
Emmanuel Raviart committed
115

116
117
```

118
### Extracting Words from CodeBooks for Autocompletion
119
120
121
122
123

```bash
npx babel-node --extensions ".ts" -- src/scripts/index_words.ts
```

124
125
## Development

126
127
128
129
130
131
132
### Extracting TypeScript Raw Types from DDI Files

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

```bash
npx babel-node --extensions ".ts" --max-old-space-size=10240 -- src/scripts/raw_types_from_ddi_files.ts ../public_data/adisp-oai-pmh-ddi-repaired/ ../public_data/sciencespo-dataverse-ddi/ ../public_data/ined-nesstar-ddi/

Emmanuel Raviart's avatar
Emmanuel Raviart committed
133
134
135
136
npx babel-node --extensions ".ts" --max-old-space-size=10240 -- src/scripts/raw_types_from_ddi_files.ts ../public_data/adisp-oai-pmh-ddi-repaired/ ../public_data/sciencespo-dataverse-ddi/ ../public_data/ined-nesstar-ddi/ --version=1.2.2
npx babel-node --extensions ".ts" --max-old-space-size=10240 -- src/scripts/raw_types_from_ddi_files.ts ../public_data/adisp-oai-pmh-ddi-repaired/ ../public_data/sciencespo-dataverse-ddi/ ../public_data/ined-nesstar-ddi/ --version=1.3
npx babel-node --extensions ".ts" --max-old-space-size=10240 -- src/scripts/raw_types_from_ddi_files.ts ../public_data/adisp-oai-pmh-ddi-repaired/ ../public_data/sciencespo-dataverse-ddi/ ../public_data/ined-nesstar-ddi/ --version=2.5

137
138
139
# Prettify generated TypeScript file:
npm run prettier
```
Emmanuel Raviart's avatar
Emmanuel Raviart committed
140

141
#### Extracting TypeScript Raw Types for Other Tests
142

Emmanuel Raviart's avatar
Emmanuel Raviart committed
143
```bash
144
145
146
147
npx babel-node --extensions ".ts" --max-old-space-size=8192 -- src/scripts/raw_types_from_ddi_files.ts ../public_data/adisp-manual-ddi/ --target=src/raw_types/codebooks_adisp_manual.ts
npx babel-node --extensions ".ts" --max-old-space-size=8192 -- src/scripts/raw_types_from_ddi_files.ts ../public_data/adisp-nesstar-ddi/ --target=src/raw_types/codebooks_adisp_nesstar.ts
npx babel-node --extensions ".ts" -- src/scripts/raw_types_from_ddi_files.ts ../public_data/sciencespo-dataverse-ddi/ --target=src/raw_types/codebooks_sciencespo_dataverse.ts
npx babel-node --extensions ".ts" -- src/scripts/raw_types_from_ddi_files.ts ../public_data/ined-nesstar-ddi/ --target=src/raw_types/codebooks_ined_nesstar.ts
Emmanuel Raviart's avatar
Emmanuel Raviart committed
148
149
150
151

# Prettify generated TypeScript files:
npm run prettier
```
152
153
154
155
156
157
158
159
160
161
162
163

### 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;
164
165
166
167
168
169
170
171
172

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