diff --git a/README.md b/README.md index 5d1822b..51f2a70 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ model shown in Figure 2, and gen automatically converts between formats as neede ![Figure 2](docs/figures/figure_2.svg) -**_Figure 2_**: _Segment graph model corresponding to the sequence variant in Figure 2. The original sequence was +**_Figure 2_**: _Segment graph model corresponding to the sequence variant in Figure 1. The original sequence was split into 3 parts; the modified sequence path is defined by a list of nodes that refer to these segments. Nodes are labeled by their parent ID and starting coordinate, new edges internal to the reference are shown as dashed arrows._ @@ -71,52 +71,33 @@ install a linker. For macOS to Linux this can be done as follows: The executable will be placed in ./target/x86_64-unknown-linux-gnu/release/ ## Usage +Gen is a command line tool with multiple subcommands that each have their own flags and arguments. The currently +available commands are listed below and described in more detail [here](docs/commands.md) or built-in help pages (`gen +[COMMAND] --help`). + +``` +Usage: gen [OPTIONS] [COMMAND] + +Commands: + import Import a new sequence collection + update Update a sequence collection with new data + init Initialize a gen repository + branch Manage and create branches + checkout Migrate a database to a given operation + reset + operations View operations carried out against a database + apply + export Export a sequence collection + defaults Set a default database and collection to use + help Print this message or the help of the given subcommand(s) + +Options: + -d, --db The path to the database you wish to utilize + -h, --help Print help + -V, --version Print version +``` Typical workflows are illustrated in these example workflows: - [Mapping reads to the human genome, taking into account all known variants](examples/human_variation_aware_alignment/Analysis.ipynb) - [Design and analysis of a combinatorial plasmid library constructed via one-pot cloning](examples/combinatorial_plasmid_design/combinatorial_design.md) - [Modeling a cross between two yeast strains starting from variant calls or genome assemblies](examples/yeast_crosses/Analysis.md) - -### Starting a new repository -`gen --db init` - - - -`gen --db import --fasta --name ` - -### Cloning an existing repository - - - - - -### Recording sequence changes - -Sequence variants observed through NGS can be imported into a gen repository via standard VCF file obtained from variant -callers like Freebayes, GATK, or DeepVariant. [...] - - - - - - -### Associating numerical data with paths and edges - - - - -### Commits and merges - - - - - - - -