search

sidora-tools / sidora.cli

A CLI for terminal based data extraction and summary for the MPI-SHH Department of Archaeogenetics PANDORA Database
Other
0 stars 0 forks source link

Module [examples] #12

Open nevrome opened 4 years ago

nevrome commented 4 years ago

When playing with the tool as it is right now time and time again I found myself wondering which columns are available in which tables.

I suggest to add a module [overview] which returns a list of column names and example column content for a given entity.

./sidora.R overview -t site
site.Id: 1, 2, 6
site.Site_Id: BDB, VLI, UNS
site.Full_Site_Id: Bad Dörrblödel, Vligenpilz, Unsepork
....
jfy133 commented 4 years ago

Not a bad idea. We could also optionally display the help/tool tip descriptions, as well as the examples to give a better idea what exactly the field describes?

Sent my from my mobile

On Fri, 12 Jun 2020, 16:21 Clemens Schmid, notifications@github.com wrote:

When playing with the tool as it is right now time and time again I found myself wondering which columns are available in which tables.

I suggest to add a module [overview] which returns a list of column names and example column content for a given entity.

./sidora.R overview -t site

site.Id: 1, 2, 6

site.Site_Id: BDB, VLI, UNS

site.Full_Site_Id: Bad Dörrblödel, Vligenpilz, Unsepork

....

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/sidora-tools/sidora.cli/issues/12, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEI6MT32QLQXYESKMHEZKLDRWI2WTANCNFSM4N4L5NDA .

nevrome commented 4 years ago

@jfy133 and @TCLamnidis Check out the new modules help and glance. Although not well polished these make using the cli much more convenient imho

jfy133 commented 4 years ago

Oooh I like it! I would like to re-write the -h/--help a bit, I find this notation very strange:

|[view], [summarise], [list], [tabulate], [glance]|

and I'm concerned that the 'help' module is not the same as --help and -h, I think that could be confusing. What about example or examples instead?

Glance is cool though (but unclear what the usecase is)

nevrome commented 4 years ago

Hm - ok - fair enough.

  1. examples sounds alright to me.
  2. Do you have an idea for a better notation in the help file? The argparser package is pretty limited in terms of text formatting unfortunately.
  3. The point of glance is to look up column names and column content structure. This module is for everybody but you, because you are the only user who has all column names of Pandora memorized down to the last underscore :stuck_out_tongue:
jfy133 commented 4 years ago

Further comment, for glance

We could have a -v / --verbose flag (or -d and --detailed) that lists the tooltips, as described here: https://mpi-dokuwiki1.server.shh.mpg.de/doku.php?id=general:pandora:field_definitions (MPI VPN required)

nevrome commented 4 years ago

See #18