Skip to content

Subcommand: citation

Lucas Czech edited this page Jun 19, 2019 · 8 revisions

Print references to be cited when using gappa.

Usage: gappa tools citation [options]

Options

Options
keys TEXT:{Czech2018-phat-and-multilevel-placement,Czech2019-analyzing-and-visualizing-samples,Czech2019-genesis-and-gappa,Evans2012-kr-distance,Matsen2011-edgepca-and-squash-clustering,Washburne2017-phylofactorization}=[] ...
Only print the citations for the given keys.
--format TEXT:{bibtex,markdown,both}=bibtex
Output format for citations.
--all Print all relevant citations used by commands in gappa.
--list List all available citation keys.

Description

The auxiliary command prints references that need to be cited when using gappa. By default, it simply prints the genesis/gappa reference itself.

It can however also be used to print other references used by commands in gappa. Each reference has a citation key (similar to how BibTeX uses them). If such keys are listed after the command, only the specificed references are printed:

gappa tools citation Czech2019-genesis-and-gappa

The --list flag prints a list of all available citation keys. Furthermore, the --all flag prints out all available references that are used in gappa commands. Using the --format option, the output format can be chosen as needed.

Clone this wiki locally