Skip to content
This repository has been archived by the owner on Jul 16, 2024. It is now read-only.

Commit

Permalink
Merge pull request #26 from moka-guys/v1.8
Browse files Browse the repository at this point in the history
Update workstation housekeeping docs to V1.8
  • Loading branch information
Aled Jones authored Apr 9, 2020
2 parents d747954 + a92ac46 commit bb8c7c9
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 15 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Workstation Housekeeping v1.7
# Workstation Housekeeping v1.8

Scripts to manage data on the NGS workstation

Expand Down Expand Up @@ -62,7 +62,6 @@ wscleaner --version # Print version number
### Usage

```bash
wscleaner --set-key DNA_NEXUS_KEY # Cache dnanexus api key
wscleaner ROOT_DIRECTORY --logfile LOGFILE_PATH
```

Expand Down
2 changes: 1 addition & 1 deletion wscleaner/DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ NF4. Attempt to process all folders at least once

A RunFolderManager class will instatiate objects for local Runfolders, each of which has an associated DNA Nexus project object. The manager loops over the runfolders and deletes them if all checks pass.

DNA Nexus projects are accessed with the dxpy module, a python wrapper for the DNA Nexus API. Credentials are cached locally using the command-line option '--set-key'.
DNA Nexus projects are accessed with the dxpy module, a python wrapper for the DNA Nexus API.
27 changes: 15 additions & 12 deletions wscleaner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,31 @@ wscleaner --version # Print version number
## Quickstart

```bash
wscleaner --set-key DNA_NEXUS_KEY # Cache dnanexus api key
wscleaner ROOT_DIRECTORY
```

## Usage

```
wscleaner [-h] [--set-key SET_KEY] [--print-key] [--dry-run]
[--logfile LOGFILE] [--min-age MIN_AGE] [--version]
root
usage: wscleaner [-h] [--auth AUTH] [--dry-run] [--logfile LOGFILE]
[--min-age MIN_AGE] [--logfile-count LOGFILE_COUNT]
[--version]
root
positional arguments:
root A directory containing runfolders to process
root A directory containing runfolders to process
optional arguments:
-h, --help show this help message and exit
--set-key SET_KEY Cache a DNA Nexus API key
--print-key Print the cached DNA Nexus API key
--dry-run Perform a dry run without deleting files
--logfile LOGFILE A path for the application logfile
--min-age MIN_AGE The age (days) a runfolder must be to be deleted
--version Print version
-h, --help show this help message and exit
--auth AUTH A text file containing the DNANexus authentication
token
--dry-run Perform a dry run without deleting files
--logfile LOGFILE A path for the application logfile
--min-age MIN_AGE The age (days) a runfolder must be to be deleted
--logfile-count LOGFILE_COUNT
The number of logfiles a runfolder must have in
/Logfiles
--version Print version
```

## Test
Expand Down

0 comments on commit bb8c7c9

Please sign in to comment.