Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lfunderburk authored Jul 7, 2020
1 parent e28df0b commit fb77c0e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions ADC-API-Data-provenance/Repertoire_Tests/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@

### Running the script

Ensure you run `generate_facet_json.py` first to generate the appropriate repertoire_id JSON input files.

usage: generate_facet_json.py [-h] [-v] base_url entry_point path_to_json

positional arguments:
base_url String containing URL to API server (e.g. https://airr-
api2.ireceptor.org)
entry_point Options: string 'rearragement' or string 'repertoire'
path_to_json Enter full path to JSON query containing repertoire ID's for
a given study - this must match the value given for study_id

optional arguments:
-h, --help show this help message and exit
-v, --verbose Run the program in verbose mode.

Example:

python 3./generate_facet_json.py "http://covid19-2.ireceptor.org" "repertoire" "./JSON-Files/repertoire/nofilters.json"

Once that has been completed, you can then run a repertoire sanity check with the facet JSON as well as the repertoire ID input JSON files.
DATA PROVENANCE TEST

usage: AIRR-repertoire-checks.py [-h] [-v]
Expand Down

0 comments on commit fb77c0e

Please sign in to comment.