Skip to content

Commit aa43a33

Browse files
author
kdaily
committed
add usage to readme.
1 parent 0590997 commit aa43a33

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,16 @@ Generate HTML usage reports for Synapse projects.
88
devtools::install_github("Sage-Bionetworks/synapseusagereports")
99
```
1010

11+
## Usage
12+
13+
### Query the warehouse
14+
15+
```
16+
./report_data_query.R --project_id=syn1234567 --start_date=2018-01-01 --end_date=2018-03-01 --config_file=~/datawarehouse-config.yml > output.csv
17+
```
18+
19+
### Generate a report
20+
21+
```
22+
./render_report.R --project_id=syn1234567 --team_order='273957' output.csv
23+
```

0 commit comments

Comments
 (0)