Skip to content

Commit

Permalink
Merge pull request #38 from fkhan72/master
Browse files Browse the repository at this point in the history
readme file updated with make file usage
  • Loading branch information
cgostic authored Feb 1, 2020
2 parents 863dcb7 + 35e8c95 commit 4e37c79
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 16 deletions.
43 changes: 30 additions & 13 deletions README.html

Large diffs are not rendered by default.

23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,21 @@ python scripts/04_data_model.py --file_path_read="data/processed/" --filename_x_
Rscript -e "rmarkdown::render('docs/05_generate_report.rmd')"
```

### Running complete project

To run the entire project, run the following commands in your command line/terminal from the root directory of this project:

```
make all
```

To clear the generated outputs from the scripts, run the following commands in your command line/terminal from the root directory of this project:

```
make clean
```


## Package Dependencies

### Python 3.7.3 and Python packages:
Expand All @@ -52,9 +67,7 @@ Rscript -e "rmarkdown::render('docs/05_generate_report.rmd')"
- docopt -- 0.6.2
- imgkit -- 1.0.2
- selenium --3.141.0
- subprocess
- canvas
- wkhtmltopdf
- subprocess.run --0.0.8

### R version 3.6.1 and R packages:

Expand All @@ -63,3 +76,7 @@ Rscript -e "rmarkdown::render('docs/05_generate_report.rmd')"
- knitr --1.27.2
- testit --0.11

### Other dependencies:

- wkhtmltopdf --0.12.4

0 comments on commit 4e37c79

Please sign in to comment.