Change the code for specifying the place to save the model: from docs…

… to data (as suggested in issue #38)
STAT547-UBC-2019-20 · Mar 24, 2020 · 4147df3 · 4147df3
1 parent eb944ae
commit 4147df3
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 10 deletions.
diff --git a/Makefile b/Makefile
@@ -19,11 +19,11 @@ images/corr.png images/facted_hist.png images/heatmap.png images/season_PM2.5.pn
 	Rscript scripts/eda.R --raw_path="data/raw_data.csv" --clean_path="data/cleaned_data.csv" --image_folder_path="images"
 
 # Generate model
-docs/model.rds : data/cleaned_data.csv scripts/model.R
-	Rscript scripts/model.R --clean_path="data/cleaned_data.csv" --model_path="docs/model.rds"
+data/model.rds : data/cleaned_data.csv scripts/model.R
+	Rscript scripts/model.R --clean_path="data/cleaned_data.csv" --model_path="data/model.rds"
 
 # Knit report
-docs/finalreport.html docs/finalreport.pdf docs/finalreport.md : images/corr.png images/facted_hist.png images/heatmap.png images/season_PM2.5.png images/year_PM2.5.png docs/finalreport.Rmd data/cleaned_data.csv data/raw_data.csv scripts/knit.R docs/model.rds
+docs/finalreport.html docs/finalreport.pdf docs/finalreport.md : images/corr.png images/facted_hist.png images/heatmap.png images/season_PM2.5.png images/year_PM2.5.png docs/finalreport.Rmd data/cleaned_data.csv data/raw_data.csv scripts/knit.R data/model.rds
 	Rscript scripts/knit.R --rmd_path="docs/finalreport.Rmd"
 
 # Clean targets    

diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ __tests__: Tests for functions.
   `Rscript scripts/eda.R --raw_path="data/raw_data.csv" --clean_path="data/cleaned_data.csv" --image_folder_path="images"`
 
   - [model.R](https://stat547-ubc-2019-20.github.io/group_12_qiyangqd_xiaoyuanf/scripts/model.R): Run a linear regression and save the model in a user defined location.
-  `Rscript scripts/model.R --clean_path="data/cleaned_data.csv" --model_path="docs/model.rds"`
+  `Rscript scripts/model.R --clean_path="data/cleaned_data.csv" --model_path="data/model.rds"`
 
   - [knit.R](https://stat547-ubc-2019-20.github.io/group_12_qiyangqd_xiaoyuanf/scripts/knit.R): Knit the final report.              
   `Rscript scripts/knit.R --rmd_path="docs/finalreport.Rmd"`

diff --git a/data/model.rds b/data/model.rds
diff --git a/docs/finalreport.Rmd b/docs/finalreport.Rmd
@@ -111,7 +111,7 @@ The purpose of the line chart was to show the change of `PM2.5` concentration ac
 ## Analysis methods
 
 ```{r}
-lm <- readRDS(file=here::here("docs", "model.rds"))
+lm <- readRDS(file=here::here("data", "model.rds"))
 tidy(lm)
 ```
 ```{r}

diff --git a/docs/finalreport.html b/docs/finalreport.html
@@ -529,7 +529,7 @@ <h3>5.Line chart</h3>
 </div>
 <div id="analysis-methods" class="section level2">
 <h2>Analysis methods</h2>
-<pre class="r"><code>lm &lt;- readRDS(file=here::here(&quot;docs&quot;, &quot;model.rds&quot;))
+<pre class="r"><code>lm &lt;- readRDS(file=here::here(&quot;data&quot;, &quot;model.rds&quot;))
 tidy(lm)</code></pre>
 <pre><code>## # A tibble: 7 x 5
 ##   term          estimate std.error statistic   p.value

diff --git a/docs/finalreport.md b/docs/finalreport.md
@@ -92,7 +92,7 @@ The purpose of the line chart was to show the change of `PM2.5` concentration ac
 
 
 ```r
-lm <- readRDS(file=here::here("docs", "model.rds"))
+lm <- readRDS(file=here::here("data", "model.rds"))
 tidy(lm)
 ```
 

diff --git a/docs/finalreport.pdf b/docs/finalreport.pdf
diff --git a/docs/finalreport.tex b/docs/finalreport.tex
@@ -297,7 +297,7 @@ \subsection{Analysis methods}\label{analysis-methods}}
 
 \begin{Shaded}
 \begin{Highlighting}[]
-\NormalTok{lm <-}\StringTok{ }\KeywordTok{readRDS}\NormalTok{(}\DataTypeTok{file=}\NormalTok{here}\OperatorTok{::}\KeywordTok{here}\NormalTok{(}\StringTok{"docs"}\NormalTok{, }\StringTok{"model.rds"}\NormalTok{))}
+\NormalTok{lm <-}\StringTok{ }\KeywordTok{readRDS}\NormalTok{(}\DataTypeTok{file=}\NormalTok{here}\OperatorTok{::}\KeywordTok{here}\NormalTok{(}\StringTok{"data"}\NormalTok{, }\StringTok{"model.rds"}\NormalTok{))}
 \KeywordTok{tidy}\NormalTok{(lm)}
 \end{Highlighting}
 \end{Shaded}

diff --git a/docs/model.rds b/docs/model.rds
diff --git a/scripts/model.R b/scripts/model.R
@@ -7,7 +7,7 @@ Usage: model.R --clean_path=<clean_data_path> --model_path=<model_path>
 "->doc
 
 # Load packages
-c <- c("tidyverse", "here", "docopt") # Create package list
+c <- c("tidyverse", "here", "docopt", "glue") # Create package list
 invisible(lapply(c, require, character.only = TRUE)) 
 
 opt <- docopt(doc)
@@ -24,7 +24,7 @@ main <- function(clean_path, model_path) {
   saveRDS(model, file = here(model_path))
 
   # message for users
-  print("Linear regression has run successfully!")
+  print(glue("Linear regression has run successfully, and the model has been saved in ", model_path, "."))
 }
-Original file line number
+Diff line change
@@ Expand Up @@
     ```r
-    lm <- readRDS(file=here::here("docs", "model.rds"))
+    lm <- readRDS(file=here::here("data", "model.rds"))
     tidy(lm)
     ```
@@ Expand Down @@