Skip to content
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

index entries and edits #18

Merged
merged 15 commits into from Jun 19, 2018
Merged

index entries and edits #18

merged 15 commits into from Jun 19, 2018

Conversation

asimumba
Copy link
Contributor

@asimumba asimumba commented May 31, 2018

I will be submitting the index entries in piecemeal. Kindly advise when you notice something odd.

asimumba added 2 commits May 30, 2018
Added index entries
Removed duplicated words.
yihui
yihui approved these changes May 31, 2018
Copy link
Member

@yihui yihui left a comment

Thanks! The keywords look more verbose than I imagined, but I'll be happy to merge this PR as is. Just let me when you are ready. I noticed you were using your master branch, so I guess I need to wait till you are done, otherwise you will have to force push later if I merge this PR.

@@ -4,11 +4,11 @@

# Installation

We assume you have already installed R (https://www.r-project.org) [@R-base] and the RStudio IDE (https://www.rstudio.com). RStudio is not required but recommended, because it makes it easier for an average user to work with R Markdown. If you do not have RStudio IDE installed, you will have to install Pandoc\index{Pandoc} (http://pandoc.org), otherwise there is no need to install Pandoc separately because RStudio has bundled it. Next you can install the **rmarkdown** package in R:
We assume you have already installed R (https://www.r-project.org) [@R-base] and the RStudio IDE (https://www.rstudio.com). RStudio is not required but recommended, because it makes it easier for an average user to work with R Markdown\index{R Markdown}. If you do not have RStudio IDE installed, you will have to install Pandoc\index{Pandoc} (http://pandoc.org), otherwise there is no need to install Pandoc separately because RStudio has bundled it. Next you can install the **rmarkdown** package in R:
Copy link
Member

@yihui yihui May 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The key word "R Markdown" is probably too general for this book.

Copy link
Contributor Author

@asimumba asimumba May 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. That's the feedback I was looking for. I will make the necessary edits and follow through all your recommendations. Thank you.

13-rticles.Rmd Outdated
```

Unless you have specific requirements for using LaTeX, we recommend that you use the R Markdown syntax. This keeps you work generally more readable (in terms of the source document), and less prone to formatting errors. For example, the above code block would be better represented as:
Unless you have specific requirements for using LaTeX, we recommend that you use the R Markdown syntax\index{R Markdown syntax}. This keeps you work generally more readable (in terms of the source document), and less prone to formatting errors. For example, the above code block would be better represented as:
Copy link
Member

@yihui yihui May 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An index is for helping readers navigate to the relevant page by keywords, so the keyword should be the key topic that a particular page or paragraph is talking about. For this paragraph, it does not actually talk about the "R Markdown syntax", so if a reader comes here from the keyword, he might be confused.

Copy link
Contributor Author

@asimumba asimumba May 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will edit that. Thank you.

@yihui
Copy link
Member

@yihui yihui commented Jun 18, 2018

Hi @asimumba, I wonder what your progress is on this PR right now. If you have not worked on it since the last time, I can just send the PDF without the index to the publisher, which will be totally fine. Thanks!

@asimumba
Copy link
Contributor Author

@asimumba asimumba commented Jun 18, 2018

@yihui ohh I'm so sorry for not finishing up on time. Something came up and I was distracted, I can finish up in less than 24 hrs.

@yihui
Copy link
Member

@yihui yihui commented Jun 18, 2018

No worries! I'll wait for you then.

@asimumba
Copy link
Contributor Author

@asimumba asimumba commented Jun 18, 2018

@yihui you can have a look. I have streamlined the index entries to a selected few. Provided this is satisfactory, you can merge this PR.

@yihui
Copy link
Member

@yihui yihui commented Jun 18, 2018

Okay. I'll take a look a couple of hours later.

@yihui yihui merged commit 4effd50 into rstudio:master Jun 19, 2018
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

Successfully merging this pull request may close these issues.

None yet

2 participants