BIOL548O / Discussion

A repository for course discussion in BIOL548O
0 stars 0 forks source link

First announcement and Homework 1 description #29

Open aammd opened 7 years ago

aammd commented 7 years ago

Hello @BIOL548O/2017_students !

This is a "Github Issue". They are a handy way of keeping discussions together on github. The purpose of this particular issue is twofold:

  1. This is an empty repository called Discussion. Any issue you post here can be read by anyone, and we can use this space to talk about questions related to the class. To attract someone's attention, write @ followed by their username. If you want to ask me a question, use @aammd. If you want to talk to everyone, use @BIOL548O/2017_students .

  2. A written explanation of the homework assignment: turn the README for your project into a brief description of your chosen data set. Try to practice some Markdown formatting techniques (for a full list see Help > Markdown Quick Reference). You can experiment with adding photographs or adding bold or italic words. See this project of mine for some ideas (raw markdown here) If you have any questions, feel free to get in touch -- perhaps below, or in a new issue!

Have a good weekend, Andrew

aesmith2 commented 7 years ago

Hi @aammd

How can I add a dagger (unicode 2020) to my readme text? I couldn't find out how to do it. :(

aesmith2 commented 7 years ago

Hey @BIOL548O/2017_students Has anyone been able to get the superscript command to work?

aammd commented 7 years ago

Hi @aesmith2 ,

Hm, i've never done that before! Looks like you can do according to this website

this is a more general point that all @BIOL548O/2017_students might be interested in: Markdown is merely an easy way to write HTML, therefore any and all HTML can be used in a markdown document. That means that if you want to do something a little bit beyond the very basic formatting that Markdown allows, you may resort to HTML to solve it (e.g. the two solutions above are HTML encodings for the dagger symbol)

aammd commented 7 years ago

hi @aesmith2 et al,

tl;dr : that superscript command (basetosquare^2^) won't work.

Superscripts and subscripts are not going to work in your README files. This is because there are in fact several dialects of Markdown, and not all support every feature. For example, so-called Github Flavoured Markdown does not have superscripts.

The markdown described in Rstudio's Help dialog is a related, but distinct, dialect of Markdown: this is "Pandoc markdown", named for pandoc, the powerful document-conversion software. Pandoc is already installed on all (most?) of your laptops, because it is installed with an R package called rmarkdown. Pandoc is part of the magic inside the famous rmarkdown reproducible documents. It has a more flexible markdown, that allows authors to write very sophisticated documents -- even scientific papers.

A long-winded answer! But believe me, there is a lot of discussion about Markdown dialects. I felt you deserved to know the truth.

obligatory xkcd

aesmith2 commented 7 years ago

I was able to get superscript to work by using < sup >entertexthere</ sup > as the code (minus the spaces between the < and sup>). Yahoooo! I was not, however, able to get the codes you suggested for the dagger to work, so I did a work-around.

aammd commented 7 years ago

@BIOL548O/2017_students I forgot to add an important basic detail: the homework is due by the start of class on Tuesday.

torhanssonfrank commented 7 years ago

Hi @BIOL548O/2017_students. When I upload a picture it is lying down instead of standing. Has anyone figured out how to turn pictures?

madelynore commented 7 years ago

@BIOL548O/2016_students Re: pictures I've also been having trouble getting captions on my pictures

![caption] (image.jpg) in Rstudio gives me the picture in github, but not the caption...

rstorlund commented 7 years ago

@torhanssonfrank I think there might be a default to upload the pictures in landscape orientation. You might have to change the size of the image to get it to upload in portrait orientation. Or crop them if possible. Just a thought...

rstorlund commented 7 years ago

@moodle2 to add a caption to your picture, just write the caption text on the next line of your readme.md. The text in the [] is alt text which shows up when your picture doesn't - it won't appear as a caption.

torhanssonfrank commented 7 years ago

Alright, thanks :) @rstorlund