From 6f413929a9cb4264baed4be9cb2b9be820963680 Mon Sep 17 00:00:00 2001 From: Gilbert Lei Date: Sat, 8 Dec 2018 16:56:50 -0800 Subject: [PATCH] final upload --- doc/README.md | 10 ++++++---- run_all.sh | 13 +++++++------ test/README.md | 18 +++++++++--------- 3 files changed, 22 insertions(+), 19 deletions(-) diff --git a/doc/README.md b/doc/README.md index 09b7e72..23ed6f7 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,10 +1,12 @@ # Documents -This folder contains all the documents, including: +This folder contains documents listed in below, including: + [proposal](./proposal.md) - - An introduction of the project that proposes the project objective, the analysis plan and the summary presentation. - + - This is the proposal of this project. It contains the project objective, the analysis plan and the expected summary presentation. + + [report RMarkdown](./Report.Rmd) + - Project report in R Markdown format. + + [report Markdown](./report.md) - - An final report of the project that summaries the project introduction, the exploratory data analysis, the analysis process and the final results. + - A final report rendered from the above Rmd file. It contains the project introduction, the exploratory data analysis, the analysis process, the analysis conclusion, and the limitations and future directions. diff --git a/run_all.sh b/run_all.sh index b6c39dc..9499aaa 100644 --- a/run_all.sh +++ b/run_all.sh @@ -8,17 +8,18 @@ ## Usage: bash run_all.sh ################################################## -# step 1 +# step 1, clean data and generate tidy data set Rscript src/01_clean_data.R data/BlackFriday.csv data/BlackFriday_tidy.csv -# step 2 +# step 2, run exploratory data analysis and save three plots Rscript src/02_visualize_data.R data/BlackFriday_tidy.csv imgs -# step 3 +# step 3, run CLT-based estimation and hypothesis test, +# save analysis results into two csv files Rscript src/03_analyze_data.R data/BlackFriday_tidy.csv results -# step 4 +# step 4, make plots to visualize analysis results Rscript src/04_generate_final_result.R results imgs -# step 5 make report -Rscript -e "rmarkdown::render('./doc/Report.Rmd', 'github_document')" \ No newline at end of file +# step 5, Render R Markdown file to generate project report +Rscript -e "rmarkdown::render('./doc/Report.Rmd', 'github_document')" diff --git a/test/README.md b/test/README.md index 9bbfe25..e5e90e1 100644 --- a/test/README.md +++ b/test/README.md @@ -1,19 +1,19 @@ # Test - This code contains some unit tests for the scripts in src/ folder. - + This folder contains some unit tests for the scripts in src/ folder. + 1. [01_unit_test](01_unit_test.R) - + Ensure that a dataframe is provided where the columns are variables for the project. - + + Ensure that a dataframe is provided where the columns are variables for the project. + 2. [02_unit_test](02_unit_test.R) + Provides unit tests for functionality of 02_visualize_data.R 3. [02_unit_test](03_unit_test.R) - + Provides unit tests for functionality of 03_analyze_data.R - + + Provides unit tests for functionality of 03_analyze_data.R + 4. [04_unit_test](04_unit_test.R) + Provides unit tests for functionality of 04_generate_final_result.R - -# Usage - To run the unit test, please open `Rstudio` and set the current working directory to the root directory of the project. Then, you are allowed to run all the unit tests. \ No newline at end of file +# Usage + + To run the unit test, please open `Rstudio` and set the current working directory to the root directory of the project. Then, you are allowed to run all the unit tests.