Giter Club home page Giter Club logo

rstudio4edu-book's People

Contributors

apreshill avatar dcossyleon avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

rstudio4edu-book's Issues

How to use this book (+ image ideas)

To add to the preface, I think we may want to make sure folks who dive into the cookbooks can find clear links/chapters based on the following 3 "wants" (inspired by our local farmer's market :):

  1. "I'm in a default mood" (image idea: like a bouquet of daisies/roses/carnations- something still nice but "classic")
    --> this link will send them to the most basic chapter of using a default template and deploying to GH Pages

  2. "I want to have nice things" (image idea: store front of bouquets that are our templates, pretty :)
    --> this link will send them to the TBD rmd4edu template they can just use

  3. "I want to learn to make nice things" (image idea: field of flowers or something, thinking custom)
    --> this link will send them to the (series of) chapters for making and then customizing the default site.

All image ideas may be trashed, just thinking we may want to highlight these 3 wants at the beginning of each cookbook, and call them out somewhere in our philosophy section.

icon rending problem?

After this most recent merge ce21d27, some icons are not rendering, like github and twitter share icons in the toolbar.

image

  • The link to the github repo is also broken. This has been broken for a while, though, so it's unrelated to the icons not rendering. But I'm not sure why it's happening

Illos

Analogies

  • cookies (or flowers) for how to use
  • airplane or engine for rstudio vs R analogy
  • House of sushi
  • Big picture package sushi schematic
  • R Markdown letter

Reference/General Flowcharts

  • Powerpoint figure of knitr/pandoc stuff
  • How can Rstudio4edu help me?
  • flowchart for the YAML/knitr things for deciding which ones to read up on
  • troubleshooting

tips

  • Design tips
  • Hat tips

just for fun

  • Living, breathing site
  • Create a better "Dress it Up" so that current "Dress it up" can be the new "Fancy"
  • About the authors
  • Distill site

Side by side code chunk and image

  • Experiment with using flex grow and similar CSS properties to get both elements side by side, and giving extra space to the image element when possible.

  • disable flexbox for mobile

Copy Code to Clipboard

  • Create a hover/ confirmation message
  • Check functionality and appearance on different browsers

make new kinds of tip divs

  • Gotchas/ Watchouts
  • tip: maybe these should be advice bits that are action-oriented.
  • FYI: more background info
  • workflow div: e.g. now push to github, etc. (or perhaps should be an rstudio tip)

Fix CSS image display block?

I think somewhere the img tag is getting a CSS assigned of display: block. This means we cannot create or show side-by-side plots like this:

```{r dodge-st, fig.show = 'hold', out.width = '50%'}
ggplot(mtcars, aes(factor(cyl), fill = factor(vs))) +
  geom_bar(position = position_dodge(preserve = "total"))

ggplot(mtcars, aes(factor(cyl), fill = factor(vs))) +
  geom_bar(position = position_dodge2(preserve = "total"))
```

Screen Shot 2019-08-10 at 8 04 24 AM

This code works in a fresh bookdown, but in ours they plots are stacked but I was able to get them side-by-side by removing the display: block.

Screen Shot 2019-08-10 at 8 04 46 AM

@dcossyleon Any ideas where this is coming from in our CSS?

select first li following part to style Introductions

  • Use adjacent sibling combinators
    example:
p + p { font-size: smaller; } /* Selects all paragraphs that follow another paragraph */
  • Need to think of a way to apply this to only the "Introduction" chapters following parts, and not non-Introduction chapters following parts.

Anchors not working

Hi, i'm not sure if the anchors are working correctly as they don't all seem to link to the right section. I noticed this recently in my book as well.

Bare bones

Anything tweakable by yaml (built-in)

Single Page:

Multi-page/ site:

Progress up to Desiree's last day ๐Ÿ˜ญ

Desiree's todo list

  1. Outline for

Templates

  1. Single lesson R Markdown

  2. All- need instructions for using in the index file

    • Hero image for example has background color, where to tell them about this? Idea: in index file give links to most critical parts of bookdown chapters

Book

  1. Single lesson R Markdown

  2. R Markdown site

  3. Distill

Illustrations

  1. Make it yours- the shelf ones
  2. Candyland
  3. Hedgehog (hex, org icon)

Loose ends/needs attention

  1. Packages- for APH
  2. Basically all screenshots
  3. Make an html table of html features table from Desiree's drawing (like which features are present in which tool)
  4. CSS crash course: can cannibalize this some? https://bookdown.org/yihui/blogdown/css.html
  5. blogdown sections (APH)

include favicon

  • see how
  • in rmd: use in_header with the following in the html (?)
    <link rel="icon" type="image/png" href="images/favicon.png"/>

Need to include:

  • in bookdown (basic -- straight in the YAML)
  • in RMD fancy sites (requires HTML)
  • distill (basic -- in YAML)

use emo::jis

esp to replace copy pasted emojis in cookbook for data package

Thinks current directory is `assets/`

@apreshill, does this ever happen to you?

I often get this error when trying to Preview Book. I get around it by making some arbitrary small change in index.Rmd and saving, and then it renders fine, but still annoying.

> bookdown:::serve_book()
Error in render_book(files, output_format, output_dir = output_dir, preview = preview_,  : 
  No input R Markdown files found from the current directory /Users/desireedeleon/Documents1/New R Projects/rstudio4edu-book/assets or in the rmd_files field of _bookdown.yml
> 

Other times it manifests as this error:

> bookdown:::serve_book()
Error in abs_path(input) : The file 'index.Rmd' does not exist.
Calls: local ... do.call -> <Anonymous> -> setwd -> dirname -> abs_path
In addition: Warning message:
In normalizePath(path, winslash = winslash, mustWork = mustWork) :
  path[1]="index.Rmd": No such file or directory
Execution halted
Error in Rscript_render(f, render_args, render_meta) : 
  Failed to compile index.Rmd
In addition: Warning message:
In xfun::prose_index(x) : Code fences are not balanced
> 

Making data packages

Hey, love your work. I've found it really helpful!

I got stuck in section 12.5 for a bit because it took my a while that I had to source the load.R script in order for the '.rda' files to get created. Kind of obvious in hindsight, but at the time I thought the script might get called by devtools along the way. A little note to source the script would be helpful for people like me who are a bit slow :)

Bookdown's download "rmd" option

Just pointing out we need to note that this requires an "edit" field.

bookdown::gitbook:
  css: assets/style.css
  config:
    toc:
      before: |
        <li><a href="./">A Minimal Book Example</a></li>
      after: |
        <li><a href="https://github.com/rstudio/bookdown" target="blank">Published with bookdown</a></li>
    download: ["rmd"]

So you'll get this error:

1: In download_filenames(config) :
  The edit link was not specified, and the download link for RMD will not work

Fixed by adding to index.Rmd YAML:

edit: https://github.com/rstudio-education/rmd4medicine/book/edit/master/%s

toc active marker for indented chapters

  • Figure out how to keep the left-border all the way on the left for all subsections.
  • Also, how to change the height of this border for the "Introduction" chapters so that the border appears to include the Part Names.

Point out GOTCHAS

  1. Do not Knit. If you've already knit, just clear out the _book folder. Always you use the addin instead.
  2. All chapter .Rmd files MUST begin with # Level 1 Header no matter what. Any content before that will not appear.
  3. ::: when creating bookdown book
  4. Making sure your book contents are put together in the right order: For this to happen automatically, you would need to create .Rmd file names that start with 01, 02, etc. This seems fine and dandy, but think of how annoying it would be if you decided to switch around the order of all your chapters--you would have to rename multiple files (ugh!). So, it is recommended to instead go to the _bookdown.yml and set the chapter order there. This is kind of like the the bookdown builder's instruction manual for chapter order. Swap around your chapters as much as you'd like in this single file and be done.
  5. _bookdown.yml, chapter_name: Should include a space after it, within the quotes!

prefix for ionicon not predictable/ not working?

  • Using the logo-name as supplied on the ionicon's website does not render the appropriate icon in rmd

The twitter icon will show up in rmd only when "ion-social-twitter" is used (this is the only ionicon example given in the R Markdown book), but the name of the icon on iconicon's website is "logo-twitter". It's not clear how anyone would know to use social as part of the prefix.

image

  • As another example, it's not clear how to figure out how to use the icon for "school". It will not render, even after trying the following:
  • ion-icon-school
  • ion-school

image

Add workflow section

You've set up, how do you now maintain? Which steps are 1x only, which steps are repeat each time you update? [insert DAVID MEZA QUOTE]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.