Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[query] Update ReferenceGenome docs #13924

Merged
merged 3 commits into from
Oct 30, 2023

Conversation

chrisvittal
Copy link
Collaborator

Add a section on managing the default reference using the default_reference method.

Add a section on managing the default reference using the
`default_reference` method.
@chrisvittal
Copy link
Collaborator Author

Next part of #13856

------------------
Hail allows setting a default reference so that the ``reference_genome``
argument of :func:`~hail.import_vcf` does not need to be used constantly.
It is a current limitation of hail that a custom reference genome cannot be
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize hail when used as a noun in English text.

It is a current limitation of hail that a custom reference genome cannot be
used as the ``default_reference`` argument of :func:`~hail.init`. In order
to set a custom reference genome as default, pass the reference as an argument
to :func:`~hail.default_reference` after initializing hail.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

@danking danking merged commit 5bc9a25 into hail-is:main Oct 30, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants