wibeasley
commented
11 years ago Key/Examples
Item 1: https://github.com/OuhscBbmc/RedcapApiExample/blob/master/Demo/PsychopathDemo/DemoSurvey.R
Item 2 (notice the SHA1 gobblety goop after 'blob'): https://github.com/OuhscBbmc/RedcapApiExample/blob/535858eec33e01ab07c86b7382d27e26cb1a442f/Demo/PsychopathDemo/DemoSurvey.R
Item 3 (notice the #L62 after 'Aim2a.R'): https://github.com/OuhscBbmc/RedcapApiExample/blob/535858eec33e01ab07c86b7382d27e26cb1a442f/Demo/PsychopathDemo/DemoSurvey.R#L62
Item 4 (notice the #L62-L65 after 'Aim2a.R'): https://github.com/OuhscBbmc/RedcapApiExample/blob/535858eec33e01ab07c86b7382d27e26cb1a442f/Demo/PsychopathDemo/DemoSurvey.R#L62-L65
Item 5 (all you have to do is enter a pound sign and the issues number, and GitHub will create the link automatically):
1
Item 6 (all you have to do is enter an ampersand and the username, and GitHub will create the link automatically and email the user): @thomasnwilson
Item 7 (enclose the visible part with [ ], then immediately enclose the url with( )):
item 1
Item 8 (enclose the code with backticks):
ds$DOB
Item 9 (start with three consecutive back ticks, then start the code on a new line, then put three consecutive back ticks on the final line by themselves):
AddOne <- function( x ) {
return( x + 1 )
}
six <- AddOne(5)Item 10 (hint -find a file on the GitHub site, then click the 'History' button in the top right, then click the SHA1 code associated with the desired commit). https://github.com/OuhscBbmc/RedcapApiExample/commit/535858eec33e01ab07c86b7382d27e26cb1a442f#CodeUtilities/PackageInstallation.R
Item 11
- [ ] Read the first post
- [ ] Read the "Comments are parsed with GitHub Flavored Markdown" link
- [ ] Read more about GFM
mand9472
GitHub 'Milestones' and 'Issues' are a critical piece of our research projects. They've help coordinate many developers and statisticians working on a single project and code base. Communication can be enhanced learning how to include more than just plain text in the issues. These touches make it easier for the reader to make connections between the post and the code.
Item 1: Create a link that will always refer to the most current version of a file, even if the file is updated after the post.
Item 2: Create a link that will refer to a snapshot of a file. So when the file is updated, the pointer does NOT refer to the newer version.
Item 3: Refer to a specific line of code in a snapshot of a file.
Item 4: Refer to a block of code in a snapshot of a file.
Item 5: Refer to another GitHub issue.
Item 6: Refer to another GitHub user.
Item 7: Hide the full url of the item 1, and display just "item 1"
Item 8: Format in-line code (eg, a variable name)
Item 9: Format a block of code.
Item 10: Refer to GitHub "diff". This allows the reader to look at the red & green lines on one screen, instead of flipping back and forth between two versions/pages.
Item 11: Create 'tasks' within an issue. GitHub released an extension to their version of markdown. It allows you to create a list of 'tasks' within an issue. https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments See an example in the comment below: