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

export: Clarify behavior of --lat-longs #1714

Closed
victorlin opened this issue Jan 10, 2025 · 1 comment · Fixed by #1715
Closed

export: Clarify behavior of --lat-longs #1714

victorlin opened this issue Jan 10, 2025 · 1 comment · Fixed by #1715
Labels
documentation Improvements or additions to documentation

Comments

@victorlin
Copy link
Member

from #1465 (comment)

Context

The help text for --lat-longs currently says:

Latitudes and longitudes for geography traits (overrides built in mappings)

This confused me in #1465, since it sounds like specifying any file will throw out all the default mappings provided by augur/data/lat_longs.tsv. As mentioned later in that issue, that is not the case.

Proposed solution

Update the help text to something along the lines of:

Latitudes and longitudes for geography traits. See the file augur/data/lat_longs.tsv for the format. This is also the default set of latitudes and longitudes. An additional file specified by this option will extend the default set. Duplicates based on the first two columns will be resolved by taking the coordinates from the user-provided file.

We may want to provide a link to the GitHub-hosted file (https://github.com/nextstrain/augur/blob/-/augur/data/lat_longs.tsv) since we shouldn't expect users to find it in their Augur installation.

@victorlin victorlin added the documentation Improvements or additions to documentation label Jan 10, 2025
@joverlee521
Copy link
Contributor

We may want to provide a link to the GitHub-hosted file (https://github.com/nextstrain/augur/blob/-/augur/data/lat_longs.tsv)

If we do include the link, we might want to point the specific Augur version instead of the default branch since the contents of the file can differ between versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants