-
Notifications
You must be signed in to change notification settings - Fork 5
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
Document AMI tools #13
Comments
AMI tools are written in
Note some of these are prototypes, others very complex. Several can be chained although at present it requires running each job separately in order |
Part of this can be automated. As mentioned in #16, picocli can generate man pages for all commands, in unix man page format as well as PDF and HTML. That is the easy part. :-) More difficult is tutorial type documentation for new users, perhaps similar to AMI-STEM.md. UPDATE: I just found https://github.com/petermr/openVirus/wiki/How-ami-search-works/ and I will edit there. |
Documentation:
One aspect of `picocli`s inheritance is to balance options in
AbstractAMITool and the subclasses. There's 20 Options and they appear in
every subclass even if they're never used.
Q1: is there a way of switching Options off completely in a subclass?
Q2: if not, can the docs be switched off?
…On Sat, Apr 4, 2020 at 11:19 PM Remko Popma ***@***.***> wrote:
Part of this can be automated. As mentioned in #16
<#16>, picocli can generate man
pages for all commands, in unix man page format as well as PDF and HTML.
That is the easy part. :-)
More difficult is tutorial type documentation for new users, perhaps
similar to AMI-STEM.md
<https://github.com/petermr/ami3/blob/master/AMI-STEM.md>.
UPDATE:
I just found
https://github.com/petermr/openVirus/wiki/How-ami-search-works/ and I
will edit there.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#13 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAFTCS4AOAMVAWRFTGIYCA3RK6W6JANCNFSM4LVSZJVQ>
.
--
Peter Murray-Rust
Founder ContentMine.org
and
Reader Emeritus in Molecular Informatics
Dept. Of Chemistry, University of Cambridge, CB2 1EW, UK
|
No description provided.
The text was updated successfully, but these errors were encountered: