From 3454a978e4000a8aebe88b0436685ec1df702048 Mon Sep 17 00:00:00 2001 From: Vince Buffalo Date: Fri, 1 Sep 2023 17:33:29 -0700 Subject: [PATCH] changes to command help --- src/main.rs | 38 ++++++++++++++++++++++++++------------ 1 file changed, 26 insertions(+), 12 deletions(-) diff --git a/src/main.rs b/src/main.rs index db3f7f0..60d748f 100644 --- a/src/main.rs +++ b/src/main.rs @@ -17,22 +17,36 @@ usage: scf [--help] Some examples: - # initialize a new project - scf init + Set up a your user metadata: + $ sdf config --name \"Joan B. Scientist\" --email \"joanbscientist@berkeley.edu\" + --affiliation \"UC Berkeley\" - # get data status - scf status + Initialize a new project: + $ sdf init - # get data sizes, etc. - scf stats - - # pull in data - scf pull + Get data status (use --remotes for remote status and/or --all for all remote files): + $ sdf status - # link the directory data/supplement/ to figshare - # use the given token - scf link data/supplement figshare [--name figshare project name] + Link the directory data/supplement/ to FigShare (requires API token): + $ sdf link data/supplement FigShare [--name project_name] + + Pull in data (you may want --overwrite): + $ sdf pull + + Push data to a remote (you may want --overwrite): + $ sdf pull + + Download a file from a URL and register it in the Data Manifest: + $ sdf get https://ftp.ensembl.org/some/path/to/large/data.fa.gz + + Bulk download data from a bunch of URLs: + $ sdf bulk links_to_data.tsv --column 1 # links are in *second* column + +See 'sdf --help' or `sdf --help`. Or, see the README at: +https://github.com/vsbuffalo/scidataflow/. +Please submit bugs or feature requests to: +https://github.com/vsbuffalo/scidataflow/issues. ";