Skip to content

Small suggestions on Chapters 8-14: typos and more #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
44 tasks done
jiapivialiu opened this issue Jun 27, 2023 · 0 comments
Open
44 tasks done

Small suggestions on Chapters 8-14: typos and more #8

jiapivialiu opened this issue Jun 27, 2023 · 0 comments
Assignees

Comments

@jiapivialiu
Copy link

jiapivialiu commented Jun 27, 2023

Some overall suggestions:

  • R code and packages are highlighted in the code style, but some of them are left to be unhighlighted.
  • Some packages highlighted as {code}, but some are in code. I'm not sure if it's done for purpose. Otherwise, It might be better to unify them.
  • The word "data" is treated as a singular at many places throughout these chapters, but as far as I know it's a plural. Correct me if I'm wrong.
  • It'd be nice to link some key R functions to their vignettes, e.g., arx_forecaster(), extract_frosting().
  • The term "predictive interval" is used at multiple places, but "prediction interval" seems to be a more frequently used term.

Some thoughts on the overall layout:

  • The table of contents on the left side always appear for relatively small text sizes and is collapsed for large text sizes. But can we adjust the width of it arbitrarily?

Chapter 8:

  • Miss a ( here.
  • When I was reading Section 8.1 the baseline models, I was wondering why these four models were suggested or used as baseline models. It'd be nice to have some brief explanation on these forecasters in this section regarding. For example, I'm wondering if they are alternatives to each other or if they are used for different research questions, and how to choose among four of them.
  • Also, I was confused at the beginning if these baseline models are models like linear regression, but then I realized that they were actually "frameworks" that allow various options of the models for model fitting. It'd be nice to clarify this somewhere in this section. Or it'd be clearer if the methodology of the forecasters are explained in more details.
  • The term "AR" is used without definition.
  • Section 8.2 mentions that “the baseline forecasters we provide requires post-processing”, but it sounds to me like the baseline forecasters wrap all four components (preprocessor -> postprocessor) from Section 8.1. It'd be better to clarify this in Section 8.1.

Chapter 9

  • There are grammar errors in this sentence. It should be "recently available data" and "they lagged".
  • This sentence mentions production forecasting, but the interpretation is not related to production forecasting. Is it a typo here? Is it actually predictive forecasting?

Chapter 10

  • Here, it does not quite make sense to me to use $ operator after epi_workflow. @rachlobay
  • In this line, there is a redundant "the" between "order" and "that".

Chapter 11

  • In here, a typo: "parsniup" should be "parsnip" and a grammar mistake: "their" should be "its".
  • The "test" sets throughout this chapter look more like validation sets, which come from the same set of samples as training sets, but the actual test sets should come from a future release. Maybe clarify this in this section?
  • In this line, in the sentence of "In a recipe, ...": remove the redundant "the"; the estimation ... and the application ... "are" done automatically, "spare".
  • This is a question. Why do we need -all_outcomes() in this line? @rachlobay
  • What does the operations section here refer to?
  • The last sentence here. I don't believe it's not simple since to switch between the two packages we just need to change the name of argument from one to another.
  • In this line, remove "use" before "perform"; "a" single interface.
  • Add the chapter link in this line.
  • Here, for "simplicity".
  • Here, "become" easier.
  • Here, a redundant "the" between "prepare" and "recipe".
  • About the three bullets (here). I'm confused with a) how they are realized in the following code? Is it through add_model and add_recipe, b) the third bullet point that "use the recipe on the predictor set to get the test set", which sounds like a future step after model fitting, and c) the pairwise difference between training set, finalized predictor set, predictor set, and test set. @rachlobay
  • Here: remove the redundant "that", add "to" before "replace".
  • There is a redundant "shown" here.
  • A redundant "is" between "package" and "helps" here.
  • We need a better way to elucidate the advantage of having the pre-processing steps here. @rachlobay

Chapter 12

  • Here and here, typos in "parsnip".
  • Here, I believe it's prediction interval, rather than confidence interval, since they are intervals for predicted values.
  • Here, there is a redundant "the" before "each of the observed ...".
  • This paragraph seems to be quite long. Maybe highlight the key words for a better readability. (working on it in other branch)
  • A typo here: it should be "one" not "once".
  • I'm confused with the first sentence here. There may be some redundancies or it may lack a comma or something.

Chapter 13

  • I'm not sure it's proper to make all states as dummy variables here. We usually use (the number of states - 1) dummy variables to avoid collinearity. Is it the same case here?
  • This chapter shows examples for panel data. It may worth mentioning it in the chapter name. (save for future work on chapter names)
  • We may need a brief explanation of what kind of panel data we refer to and what they look like.

Chapter 14

  • A redundant "in" after "such" here.
  • Here and here, the confidence bands are more like prediction bands since they are for predicted values.
  • It seems like some comments are not commented successfully here.
  • Here, "those models' high variance".
jiapivialiu added a commit that referenced this issue Jul 12, 2023
jiapivialiu added a commit that referenced this issue Aug 10, 2023
@jiapivialiu jiapivialiu reopened this Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants