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

readme

sidora.cli

A CLI for terminal based data extraction and summary for the MPI-SHH Department of Archaeogenetics PANDORA Database

Quickstart

  1. Install sidora.cli from github within R 
if(!require('remotes')) install.packages('remotes')
remotes::install_github('sidora-tools/sidora.cli')
  1. Install the script in your user directory with sidora.cli::quick_install() within R
  2. Make the main script file executable with chmod +x sidora.R
  3. Provide a .credentials file in your user directory
  4. Run it with ./sidora.R --help

This will only work within the MPI-SHH network. It also requires R and most likely a UNIX system.

For developers

The script can be found in the inst/ directory. A normal development workflow would be to modify the package, build it (!), and then run the script in inst/ (where you will need a .credentials file).