Skip to content

Commit 0400f15

Browse files
committed
Capitalise subheadings in docs
1 parent 45f3826 commit 0400f15

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/source/health_data.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Before getting into the config itself, we need to discuss a few peculiarities of
2020
However, some of these vocabulary tables may be too large to practically be writable to ``.yaml`` files, and will need to be dealt with manually.
2121
You should also check the license agreement of each standardized vocabulary before sharing any of the ``.yaml`` files.
2222

23-
Dealing with circular foreign keys
23+
Dealing with Circular Foreign Keys
2424
++++++++++++++++++++++++++++++++++
2525

2626
SSG is currently unable to handle schemas with circular foreign keys properly.
@@ -51,7 +51,7 @@ One can then proceed with ``sqlsynthgen create-vocab`` to copy over the vocabula
5151
If the problematic foreign key constraints would be between non-vocabulary tables, one would need to keep them disabled for the whole duration of creating synthetic data, while putting in a manual mechanism that guarantees that the synthetic data created does respect the constraint, and then reenable the constraint at the end.
5252
Fortunately with OMOP this is not necessary.
5353

54-
Vocabulary tables
54+
Vocabulary Tables
5555
+++++++++++++++++++++
5656

5757
The OMOP schema has many vocabulary tables. Here's an excerpt from the CCHIC OMOP config file we've written:

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Contents:
3939
glossary
4040

4141

42-
Indices and tables
42+
Indices and Tables
4343
------------------
4444

4545
* :ref:`genindex`

docs/source/introduction.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ After migration, the database has the following structure:
1717
:width: 400
1818
:alt: The AirBnb database diagram.
1919

20-
Default behavior
20+
Default Behavior
2121
----------------
2222

2323
SSG contains tools for replicating the schema of a source database.
@@ -99,7 +99,7 @@ Foreign key relations are respected by picking random rows from the table refere
9999
Even this synthetic data, nearly the crudest imaginable, can be useful for instance for testing software pipelines.
100100
Note that this data has no privacy implications, since it is only based on the schema.
101101

102-
Vocabulary tables
102+
Vocabulary Tables
103103
-----------------
104104

105105
The simplest configuration option available to increase fidelity is to mark some of the tables in the schema to be “vocabulary” tables.
@@ -166,7 +166,7 @@ To recap, “vocabularies” are tables that don’t need synthesising.
166166
By itself this adds only limited utility, since the interesting parts of the data are typically in the non-vocabulary tables, but it saves great amounts of work by fixing some tables with no privacy concerns to have perfect fidelity from the get-go.
167167
Note that one has to be careful in making sure that the tables marked as vocabulary tables truly do not hold privacy sensitive data, otherwise catastrophic privacy leaks are possible, where the original data is exposed raw and in full.
168168

169-
Specifying row-based custom generators
169+
Specifying Row-based Custom Generators
170170
--------------------------------------
171171

172172
As we’ve seen above, ``ssg.py`` is overwritten whenever you re-run ``make-generators``.
@@ -300,7 +300,7 @@ Still there are no privacy implications, but data can be generated that e.g. pas
300300

301301
.. _source_statistics:
302302

303-
Using aggregate statistics from the source data
303+
Using Aggregate Statistics from the Source Data
304304
-----------------------------------------------
305305

306306
Beyond copying vocabulary tables, SSG allows for the original data to affect the synthetic data generation process only through a particular mechanism we call source statistics.
@@ -439,7 +439,7 @@ One final aspect of source statistics bears mentioning:
439439
At the top level of ``config.yaml`` one can also set ``use-asyncio: true``.
440440
With this, if there are multiple source stats queries to be run, they will be run in parallel, which may speed up ``make-stats`` significantly if some of the queries are slow.
441441

442-
"Stories" within the data
442+
"Stories" Within the Data
443443
-------------------------
444444

445445
The final configuration option available to users of SSG is what we call "story generators".

0 commit comments

Comments
 (0)