Skip to content

Commit

Permalink
Reword FAQ titles as questions
Browse files Browse the repository at this point in the history
Otherwise the section title doesn't make sense.
  • Loading branch information
victorlin committed Apr 26, 2024
1 parent 18987b8 commit 6051f46
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/faq/clades.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Labeling `clades`
# How do I label `clades`?

Clades in phylogenetic trees are often named to facilitate discussion of genetic diversity, see for example [seasonal influenza on nextstrain](https://nextstrain.org/flu).
Augur has a command to determine the position of such clade labels and assign sequences to clades.
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ common questions and problems users run into.
metadata
clades
refine
Creating a tree using your own tree builder <skip_augur_tree>
skip_augur_tree
4 changes: 2 additions & 2 deletions docs/faq/metadata.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Preparing Your Metadata
=======================
How do I prepare metadata?
==========================

Analyses are vastly more interesting if the sequences or samples
analyzed have rich 'meta data' wherever possible. This metadata could
Expand Down
6 changes: 3 additions & 3 deletions docs/faq/refine.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
===========================
Specifying ``refine`` rates
===========================
==================================
How do I specify ``refine`` rates?
==================================

How we use refine in the zika tutorial
======================================
Expand Down
6 changes: 3 additions & 3 deletions docs/faq/skip_augur_tree.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
===========================================
Creating a tree using your own tree builder
===========================================
=================================
How do I use my own tree builder?
=================================

The `augur tree` command is a light wrapper around tree building programs such as IQ-TREE, RAxML and FastTree.
It's possible that the functionality you want isn't available in those programs, or that it is available but that `augur tree` doesn't expose the functionality you need.
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/what-is-a-build.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The concept of a 'build'
# What is a "build"?

Nextstrain's focus on providing a _real-time_ snapshot of evolving pathogen populations necessitates a reproducible analysis that can be rerun when new sequences are available.
The individual steps necessary to repeat analysis together comprise a "build".
Expand Down

0 comments on commit 6051f46

Please sign in to comment.