aboutsummaryrefslogtreecommitdiff
path: root/clinvar.1
diff options
context:
space:
mode:
Diffstat (limited to 'clinvar.1')
-rw-r--r--clinvar.120
1 files changed, 20 insertions, 0 deletions
diff --git a/clinvar.1 b/clinvar.1
new file mode 100644
index 0000000..aa9d283
--- /dev/null
+++ b/clinvar.1
@@ -0,0 +1,20 @@
+.TH CLINVAR 1
+.SH NAME
+clinvar \- FZF based interface to clinvar for variant searching
+.SH SYNOPSYS
+\fBclinvar\fP \fIterm\fP ...
+.SH DESCRIPTION
+\fBclinvar\fP searches for the given terms in the clinvar database.
+A search is conducted and if multiple results are available they are
+displayed in FZF with a preview of the variant details. A variant
+can be selected to view details of the evidence associated with that
+variant.
+.P
+If a variant is selected, the evidence will be shown in FZF and the
+preview used to show additional free-text description associated with
+the highlighted evidence entry. Cancelling or making a selection will
+return to the search results.
+.SH BUGS
+As the NCBI results navigation is stateful, only the first 200 results
+can be shown. Out of these, only the subset with variant identifiers
+are displayed. This can result in a short list for large queries.