Skip to content

Commit

Permalink
format the new docs as a warning
Browse files Browse the repository at this point in the history
  • Loading branch information
aryarm authored Dec 20, 2024
1 parent f9e1fed commit d1f7e42
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/commands/simgenotype.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,9 @@ If speed is important, it's generally faster to use PGEN files than VCFs.
--pop_field \
--out tests/data/example_simgenotype.pgen
Writing PGEN files will require more memory than writing VCFs. The memory required will depend on the number of simulated samples and variants.
You can reduce the memory required by this step by writing the variants in chunks. Just specify a ``--chunk-size`` value.
.. warning::
Writing PGEN files will require more memory than writing VCFs. The memory required will depend on the number of simulated samples and variants.
You can reduce the memory required by this step by writing the variants in chunks. Just specify a ``--chunk-size`` value.

All files used in these examples are described :doc:`here </project_info/example_files>`.

Expand Down

0 comments on commit d1f7e42

Please sign in to comment.