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

Update skeleton.Rmd to fix URL to source Rmd #19

Merged
merged 1 commit into from Oct 26, 2017

Conversation

Projects
None yet
2 participants
@benmarwick
Contributor

benmarwick commented Oct 26, 2017

Also, I think it could be helpful to users to add this example YAML into this doc to complement the example you have for the tufte pkg:

---
title: "An Example Using the Tufte Style"
author: "John Smith"
output:
  tint::tintHtml: 
     self_contained: TRUE
---

This YAML is what I was looking for when I noticed that the URL to the Rmd source was wrong. What do you think?

Update skeleton.Rmd
Also, I think it could be helpful to users to add this example YAML into this doc to complement the example you have for the `tufte` pkg:

```
---
title: "An Example Using the Tufte Style"
author: "John Smith"
output:
  tint::tintHtml: 
     self_contained: TRUE
---
```

This YAML is what I was looking for when I noticed that the URL to the Rmd source was wrong. What do you think?

@eddelbuettel eddelbuettel merged commit 0fa084b into eddelbuettel:master Oct 26, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@eddelbuettel

This comment has been minimized.

Show comment
Hide comment
@eddelbuettel

eddelbuettel Oct 26, 2017

Owner

Now that I have worked on pinp and linl, this one is due for an update.

Now, the PR here was clear. But I am not entirely sure what you by 'this example YAML'. Can you clarify? Or Amazon Prime me some stronger coffee so that I get out of my doze ... ;-)

Owner

eddelbuettel commented Oct 26, 2017

Now that I have worked on pinp and linl, this one is due for an update.

Now, the PR here was clear. But I am not entirely sure what you by 'this example YAML'. Can you clarify? Or Amazon Prime me some stronger coffee so that I get out of my doze ... ;-)

@eddelbuettel eddelbuettel referenced this pull request Oct 26, 2017

Closed

fix URL to source #18

@benmarwick

This comment has been minimized.

Show comment
Hide comment
@benmarwick

benmarwick Oct 26, 2017

Contributor

Yes, I was thinking that for people who don't use the RStudio templates dialog box when starting a new Rmd, and want to edit their YAML by hand, it would be helpful to have a snippet of YAML to copy-paste into a Rmd to get the tint style.

As I skimmed the text at http://eddelbuettel.github.com/tint/, I saw the YAML in the Introduction section for the tufte package. But what I was expecting to see there was the YAML for this tint package so I could style my Rmd with it. I guess that some other readers might have the same experience.

Having the tint YAML handy in that introductory doc that would make it a bit easier for potential users to see how to use the style. Especially if the YAML is the main way they edit R Markdown styles (perhaps it's just me? and Emacs users?). Saves us from having to guess at tint::tint_html etc. or switch contexts to check the pkg manual pages (quelle horreur).

Hope that helps! ☕️ ☕️

Contributor

benmarwick commented Oct 26, 2017

Yes, I was thinking that for people who don't use the RStudio templates dialog box when starting a new Rmd, and want to edit their YAML by hand, it would be helpful to have a snippet of YAML to copy-paste into a Rmd to get the tint style.

As I skimmed the text at http://eddelbuettel.github.com/tint/, I saw the YAML in the Introduction section for the tufte package. But what I was expecting to see there was the YAML for this tint package so I could style my Rmd with it. I guess that some other readers might have the same experience.

Having the tint YAML handy in that introductory doc that would make it a bit easier for potential users to see how to use the style. Especially if the YAML is the main way they edit R Markdown styles (perhaps it's just me? and Emacs users?). Saves us from having to guess at tint::tint_html etc. or switch contexts to check the pkg manual pages (quelle horreur).

Hope that helps! ☕️ ☕️

@eddelbuettel

This comment has been minimized.

Show comment
Hide comment
@eddelbuettel

eddelbuettel Oct 26, 2017

Owner

I think we are on the same page. What I may not have know last year and up to the last update of the package is that rmarkdown supports this, and I now show this in the help pages for pinp and linl.

So try, respectively,

R> rmarkdown::draft("myTintHtml.Rmd", template="html", package="tint", edit=FALSE)
R> rmarkdown::draft("myTintPdf.Rmd", template="pdf", package="tint", edit=FALSE)
R> 

If you set edit=TRUE (the default) then an editor gets called. I may have the wrong emacsclient within emacsclient default so no go in ESS but surely works outside. Then again I never set the EDITOR option ...

Edit: So ESS itself sets options("editor") to emacsclient but I can't call emacsclient from within emacsclient. Stallman clearly needs another MacArthur grant to solve that problem for me ...

Owner

eddelbuettel commented Oct 26, 2017

I think we are on the same page. What I may not have know last year and up to the last update of the package is that rmarkdown supports this, and I now show this in the help pages for pinp and linl.

So try, respectively,

R> rmarkdown::draft("myTintHtml.Rmd", template="html", package="tint", edit=FALSE)
R> rmarkdown::draft("myTintPdf.Rmd", template="pdf", package="tint", edit=FALSE)
R> 

If you set edit=TRUE (the default) then an editor gets called. I may have the wrong emacsclient within emacsclient default so no go in ESS but surely works outside. Then again I never set the EDITOR option ...

Edit: So ESS itself sets options("editor") to emacsclient but I can't call emacsclient from within emacsclient. Stallman clearly needs another MacArthur grant to solve that problem for me ...

@benmarwick benmarwick deleted the benmarwick:patch-3 branch Oct 27, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment