Things to fix for Milestone 2 submission

[MacyChan]

I have reorganised a potential structures for our project

Overview

• Shell script, to be in READ.ME usage

  Steps:

  0. (Optional) Remove output file if exist
  1. download and unzip data to /data/raw
  2. run eda report (Output Rmd, md, html) Rscript -e "rmarkdown::render('src/Beijing_air_quality_EDA.Rmd')"
  3. pre-process data /data/process
  4. create exploratory data analysis figure and write to file /results
  5. create hypothesis testing data/figures and write to file /results
  6. render final report (Output Rmd, md, html) /doc Rscript -e "rmarkdown::render('doc/Beijing_air_quality_report.Rmd', output_format = 'github_document')"

Actual Content

data

raw file for unzipped data processed data for needed data only

src

download and unzip data to /data/raw eda report create exploratory data analysis figure and write to file /results create hypothesis testing data/figures and write to file /results

result

EDA figures hypothesis testing data/figures

doc

a bunch of child RMD for the content of final report a reference file render final report (Output Rmd, md, html) /doc

Reference: https://github.com/ttimbers/breast_cancer_predictor/tree/v2.0 https://github.com/mine-cetinkaya-rundel/fresh-ds

Milestone 2 summary https://pages.github.ubc.ca/mds-2021-22/DSCI_522_dsci-workflows_students/materials/assignments/milestone2.html

• Write a script that reads the downloaded data and performs and data cleaning/pre-processing, transforming, and/or splitting
• Write a script which creates exploratory data visualization(s) and table(s) that are useful to help the reader/consumer understand that data set
• Write a script that performs some statistical or machine learning analysis and summarizes the results as a figure(s) and a table(s)
• Write a literate code document which presents your analysis and findings
• Iterate on work done for milestone 1 as required per TA feedback

[Jacq4nn]

Changes to be made: SRC

• eda_generate_plots.R --> eda script by @MacyChan

data/processed

• delete data.csv

[Jacq4nn]

For reference: https://github.com/mine-cetinkaya-rundel/fresh-ds

[MacyChan]

Final report Rmd

1. Hypothesis Testing - better Unbold the title
2. Figure 1 has two captions Remove the fig.cap so that it is normal for both version Figure 1. China has yet to reach the point of inflexion Figure 1: China has yet to reach the point of inflexion (Sanders 2017)