Skip to content

Instantly share code, notes, and snippets.

View chahatupreti's full-sized avatar

Chahat Upreti chahatupreti

  • University of Texas at Dallas
  • Dallas
View GitHub Profile
# file is downloaded from covid19.sanger.ac.uk with customised lineage selection
data<- read_csv("C:/Users/Theo/Desktop/Estimated_Cases_in_England (2).csv")
library(gganimate)
data$date
library(MetBrewer)
lookup =c("B"="Other B lineages","B.1.1.529"="Omicron", "B.1.1.7"="Alpha","B.1.617.2"="Delta","B.1.177"="B.1.177","AY.4.2"="AY.4.2")

As others have noted, README should be simple and short, but a good README can save time especially if it's for something like command-line parameter parsing library.

Here's what I think it should include:

name of the projects and all sub-modules and libraries (sometimes they are named different and very confusing to new users)
descriptions of all the project, and all sub-modules and libraries
5-line code snippet on how its used (if it's a library)
copyright and licensing information (or "Read LICENSE")
instruction to grab the documentation

instructions to install, configure, and to run the programs