Making text files look attractive

July 16, 2020 • PD Schloss • 3 min read

A text file is just that - a file with only text. Thinking about a document you might write in Microsoft Word there’s the text, but there’s also formatting, fonts, layouts, and more. A text file is only the text. Often that is limiting because some amount of formatting is helpful to organize our text. In today’s episode we’ll learn how to use a language called “markdown” to apply light formatting to our README and other text files. You may have noticed that our README files are actually called README.md. That “md” extension is short for markdown. Some people prefer to use “markdown” as the extension. Markdown may not seem like a big deal right now, but as we proceed with this project, we’ll see how we can blend code that we want executed with text using a tool called “R Markdown.” In this episode, we’ll also introduce a new text editor as an alternative to nano, which is called atom. atom is developed to be compatible with GitHub and has the ability to show us what our markdown formatting would look like when viewed on GitHub. Today’s episode may not seem like it’s advancing us very far towards answering our question of how inter- and intra-genomic variation affects the ability to interpret amplicon sequence variants (ASVs), but it is a significant departure from how most people approach documenting their work.

Please take the time to watch today’s episode, follow along on your own computer, and attempt the exercises. Don’t worry if you aren’t sure how to solve the exercises, at the end I will provide solutions.

The reference notes and links that follow are a supplement to the material in the video. The exercises and their solutions are provided at the bottom.

Installations

For today’s code club and future episodes, we’ll make use of a text editor called atom. You need to go to their site and install atom.

Markdown cheat-sheet

There are many flavors of “markdown”. Because our files will be hosted on GitHub, we will use “GitHub-flavored markdown”. There is an excellent cheat sheet that will remind you of how to implement different features of markdown that will be visible on GitHub’s website. This is a very popular flavor and will work well with other tools we’ll be using later in the project.

Exercises

1. Looking at the GitHub-flavored markdown reference materials, recreate the sentence “I will write my documents in Microsoft Word markdown.”

I will write my documents in ~~Microsoft Word~~ markdown.

2. Looking at the GitHub-flavored markdown reference materials, create a check list with the following items.

- [ ] Download the rrnDB tsv file
- [ ] Download the rrnDB fasta file
- [ ] Download the rrnDB taxonomy files
- [ ] Download the SILVA SEED files

3. Complete Issue 7

comments powered by Disqus