|
|
| (255 intermediate revisions by the same user not shown) |
| Line 5: |
Line 5: |
| | | | |
| | | | |
| − | {{dev}}
| + | This is a hub for a first introduction to '''R''', for students of one of my workshops or courses. I have subdivided the material into (somewhat) independent learning units that you can work through at your own pace, but in sequence. |
| | | | |
| | + | The units have ''Deliverables'' and ''Prerequisites'' - please ignore these sections, they are for use in a more formal course setting. |
| | | | |
| − | This is a tutorial introduction to '''R''' for users with no previous background in the platform or the language.
| + | You need to work through these units '''before''' you come to the workshop. There are two reasons: |
| | | | |
| | + | * (i) installation of software is very specific to your computer and we can't walk you through this in a room full of people. It would take so much time that we won't get anything else done. |
| | + | * (ii) When you are working with '''R''' - like with any computer language or natural language, the key is repetition, repetition, repetition. The more you prime yourself with this material, the more you will profit when we actually meet in class. I hope to see everyone radiant and elated, and not lost before we even begin. Let's do this! |
| | | | |
| − | __TOC__
| |
| | | | |
| | | | |
| − |
| |
| − | ==The environment==
| |
| − | In this section we discuss how to download and install the software, how to configure an '''R''' session and what work with the '''R''' environment includes.
| |
| | | | |
| − | ===Installation===
| |
| | | | |
| − | # Navigate to http://probability.ca/cran/ <ref>This is the CRAN mirror site at the University of Toronto, any other mirror site will do. You may access a choice of mirror sites from the [http://r-project.org '''R'''-project homepage].</ref> and follow the link to your computer's operating system.
| |
| − | # Download a precompiled binary (or "build") of the R "framework" to your computer and follow the instructions for installing it. You don't need tools, or GUI versions for now, but do make sure that the program is the correct one for your '''version''' of your operating system.
| |
| − | # Launch '''R'''.
| |
| | | | |
| − | The program should open a window–the "R console"–and greet you with its ''input prompt'', awaiting your input: | + | ==The Units== |
| − | >
| |
| | | | |
| | + | {{Smallvspace}} |
| | | | |
| − | The sample code on this page sometimes copies input/output from the console, and sometimes shows the actual commands only. The <code>></code> character at the beginning of the line is always just '''R''''s ''input prompt''; It is shown here only to illustrate the interactive use of the program and you do not need to type it. If a line starts with <code>[1]</code> or similar, this is '''R''''s ''output'' on the console. A <code>#</code>-character this marks the following text as a comment which is not executed by '''R'''. In principle, commands can be copied by you and pasted into the console, or into a script - obviously, you don't need to copy the comments. In addition, I use [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi syntax highlighting] on '''R'''-script, to color language keywords, numbers, strings, etc. different from other text. This improves readability but keep in mind that the colours you see on your computer will be different. One more thing about the console: use your keyboard's ''up-arrow'' keys to retrieve previous commands, then enter the line with ''left-arrow'' to edit it; hit ''enter'' to execute the modified line.
| + | ; Start with this: |
| | + | * [[FND-Biocomputing_setup| Set up your computer for biocomputing work]] |
| | | | |
| − | ===User interface===
| + | {{Smallvspace}} |
| | | | |
| − | R comes with a GUI<ref>Graphical User Interface</ref> to lay out common tasks. For example, there are a number of menu items, many of which are similar to other programs you will have worked with ("File", "Edit", "Format", "Window", "Help" ...). All of these tasks can also be accessed through the command line. In general, GUIs are useful when you are not sure what you want to do or how to go about it; the command line is much more powerful when you have more experience and know your way around in principle. '''R''' gives you both options. | + | ; Install R and make sure everything works: |
| | + | * [[RPR-Installation| Installing R and RStudio]] |
| | + | * [[RPR-Setup| Setup]] |
| | + | * [[RPR-Console| The "Console"]] |
| | + | * [[RPR-Help| Getting Help]] |
| | | | |
| − | In addition to the ''Console'', there are a number of other windows that you can open (or that open automatically). They all can be brought to the foreground with the '''Windows''' menu and include help, plotting, package browser and other windows.
| + | {{Smallvspace}} |
| | | | |
| − | Let's begin with a glossary of some terms that '''R''' uses and how they relate to your work:
| + | ; Explore how to get '''R''' to work with data: |
| | + | * [[RPR-Syntax_basics| R Syntax]] |
| | + | * [[RPR-Objects-Vectors| Vectors]] |
| | + | * [[RPR-Objects-Data_frames| Data frames]] |
| | + | * [[RPR-Objects-Lists| Lists]] |
| | | | |
| − | ;Help
| + | {{Smallvspace}} |
| − | :Help is available for all commands and for the R command line syntax. As well, help is available to find the names of commands when you are not sure of them.
| |
| | | | |
| | + | ; The one unit that will save your ***, over and over again: |
| | + | * [[RPR-Subsetting| Subsetting and Filtering]] |
| | | | |
| − | <small>("help" is a function, arguments to a function are passed in parentheses "()")</small>
| + | {{Smallvspace}} |
| − | <source lang="rsplus">
| |
| − | > help(rnorm)
| |
| − | >
| |
| − | </source>
| |
| | | | |
| | + | ; First steps towards programming: |
| | + | * [[RPR-Subsetting| Subsetting and Filtering]] |
| | + | * [[RPR-Control_structures| Control structures]] |
| | + | * [[RPR-Functions| Functions]] |
| | | | |
| − | <small>(shorthand for the same thing)</small>
| + | {{Smallvspace}} |
| − | <source lang="rsplus">
| |
| − | > ?rnorm
| |
| − | >
| |
| − | </source>
| |
| | | | |
| | + | ; Maybe optional? Meh, just work through this anyway, as time permits. It'll be on the exam. |
| | + | * [[RPR-Subsetting| Subsetting and Filtering]] |
| | + | * [[RPR-Plotting| First Plots]] |
| | + | * [[RPR-Coding_style| Coding Style]] |
| | | | |
| − | <small>(what was the name of that again ... ?)</small>
| |
| − | <source lang="rsplus">
| |
| − | > ?binom
| |
| − | No documentation for 'binom' in specified packages and libraries:
| |
| − | you could try '??binom'
| |
| − | > ??binom
| |
| − | >
| |
| − | </source>
| |
| | | | |
| | + | {{Vspace}} |
| | | | |
| − | <small>(found "Binomial" in the list of keywords)</small>
| |
| − | <source lang="rsplus">
| |
| − | > ?Binomial
| |
| − | >
| |
| − | </source>
| |
| − |
| |
| − |
| |
| − | That's all fine, but you wil soon notice that '''R''''s help documentation is not all that helpful for the newcomers (who need the most help). If you look at the bottom of the help function, you will usually find examples of command usage; these often make matters more clear than the terse and principled help-text above. Or you can just Google for what interests you and this is often the quickest way to find working example code. Also, as a result of Google search it may turn out for example that something ''can't'' be done (easily)–and you won't find things that can't be done at all in the help system. You may want to include {{c|"r language"}} in your search terms, although Google is usually pretty good at figuring out what kind of "r" you are looking for, if your query includes a few terms vaguely related to statistics.
| |
| − |
| |
| − | There is also an active [https://stat.ethz.ch/mailman/listinfo/r-help '''R-help mailing list'''] which you can post to–or at least search the archives: your question probably has been asked and answered before.
| |
| − |
| |
| − |
| |
| − | ;Working directory
| |
| − | To locate a file in a computer, one has to specify the ''filename'' and the directory in which the file is stored; this is sometimes called the ''path'' of the file. The "working directory" for '''R''' is either the direcory i which the '''R'''-program has been installed, or some other directory, as initialized by a startup script. You can execute the command <code>getwd()</code> to list what the "Working Directory" is currently set to:
| |
| − |
| |
| − |
| |
| − | <source lang="rsplus">
| |
| − | > getwd()
| |
| − | [1] "/Users/steipe/R"
| |
| − | </source>
| |
| − |
| |
| − |
| |
| − | It is convenient to put all your '''R'''-input and output files into a project specific directory and then define this to be the "Working Directory". Use the {{c|setwd()}} command for this. {{c|setwd()}} requires a parameter in its parentheses: a string with the directory path. Strings in R are delimited with {{c|"}} or <code>'</code> characters. If the directory does not exist, an Error will be reported. Make sure you have created the directory. On Mac and Unix systems, the usual shorthand notation for relative paths can be used: <code>~</code> for the home directory, <code>.</code> for the current directory, <code>..</code> for the parent of the current directory.
| |
| − |
| |
| − |
| |
| − | {{console|My home directory...
| |
| − | |> setwd("~")
| |
| − | > getwd()
| |
| − | [1] "/Users/steipe"
| |
| − | }}
| |
| − |
| |
| − | {{console|Relative path: home directory, up one level, then down into chen's home directory)
| |
| − | |> setwd("~/../chen")
| |
| − | > getwd()
| |
| − | [1] "/Users/chen"
| |
| − | }}
| |
| − |
| |
| − | {{console|Absolute path: specify the entire string)
| |
| − | |> setwd("/Users/steipe/abc/R_samples")
| |
| − | > getwd()
| |
| − | [1] "Users/steipe/abc/R_samples"
| |
| − | }}
| |
| − |
| |
| − | {{task|
| |
| − | # Create a directory for your sample files and use {{c|setwd("''your-directory-name''")}} to set the working directory.
| |
| − | # Confirm that this has worked by typing {{c|getwd()}}.
| |
| − | }}
| |
| − |
| |
| − | The ''Working Directory'' functions can also be accessed thorugh the Menu, under '''Misc'''.
| |
| − |
| |
| − |
| |
| − | ;Workspace
| |
| − | During an '''R''' session, you might define a large number of variables, datastructures, load packages and scripts etc. All of this information is stored in the so-called "Workspace". When you quit '''R''' you have the option to save the Workspace; it will then be reloaded in your next session.
| |
| − |
| |
| − |
| |
| − | {{console|List the current workspace contents: initially it is empty. (R reports an object of type "character" with a length of 0.)
| |
| − | |> ls()
| |
| − | character(0)
| |
| − | >
| |
| − | }}
| |
| − |
| |
| − | {{console|Initialize three variables (multiple commands on one line can be separated with a semicolon";")
| |
| − | |> a <- 1; b <-2; eps <- 0.0001
| |
| − | > ls()
| |
| − | [1] "a" "b" "eps"
| |
| − | >
| |
| − | }}
| |
| − |
| |
| − | {{console|Remove one item. (Note: the parameter is not the string "''a''", but the variable name ''a''.)
| |
| − | |> rm(a)
| |
| − | > ls()
| |
| − | [1] "b" "eps"
| |
| − | >
| |
| − | }}
| |
| − |
| |
| − | <small>We can use the output of {{c|ls()}} as input to {{c|rm()}} to remove everything and clear the Workspace. (cf. {{c|?rm}} for details)</small>
| |
| − | <source lang="rsplus">
| |
| − | rm(list= ls())
| |
| − | > ls()
| |
| − | character(0)
| |
| − | >
| |
| − | </source>
| |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| − | ===Packages===
| |
| − |
| |
| − | '''R''' has many powerful functions built in, but one of it's greatest features is that it is easily extensible. Extensions have been written by legions of scientists for many years, most commonly in the '''R''' programming language itself, and made available through [http://cran.r-project.org/ '''CRAN'''–The Comprehensive R Archive Network]. A package is a collection of code, documentation and sample data files. To use packages, you need to install them (once), and add them to your current session (for every new session). You can get an overview of installed and loaded packages by opening the '''Package Manager''' window from the '''Packages & Data''' Menu item. It gives a list of available packages you currently have ''installed'', and identifies those that have been ''loaded'' at startup, or interactively.
| |
| − |
| |
| − | {{task|
| |
| − | * Navigate to http://cran.r-project.org/web/packages/ and read the page.
| |
| − | * Navigate to http://cran.r-project.org/web/views/ (the CRAN task-views.
| |
| − | * Follow the link to '''Genetics''' and read the synopsis of available packages. The library {{c|sequinr}} sounds useful, but check first whether it is already installed.
| |
| − | {{console
| |
| − | |{{c|library()}} opens a window of installed packages in the library; {{c|search()}} shows which one are currently loaded.
| |
| − | |> library()
| |
| − | > search()
| |
| − | [1] ".GlobalEnv" "tools:RGUI" "package:stats" "package:graphics"
| |
| − | [5] "package:grDevices" "package:utils" "package:datasets" "package:methods"
| |
| − | [9] "Autoloads" "package:base"
| |
| − | }}
| |
| − |
| |
| − |
| |
| − | * In the '''R packages available''' window, confirm that {{c|seqinr}} is not yet installed.
| |
| − | * Follow the link to {{c|seqinr}} to see what standard information is available with a package. Then follow the link to '''Reference manual''' to access the documentation pdf. This is also sometimes referred to as a "vignette" and contains usage hints and sample code.
| |
| − | {{console
| |
| − | | Read the help for {{c|vignette}}. Note that there is a command to extract '''R''' sample code from a vignette, to experiment with it.
| |
| − | |> ?vignette
| |
| − | >
| |
| − | }}
| |
| − |
| |
| − |
| |
| − | {{console
| |
| − | | Install {{c|seqinr}} from the closest CRAN mirror and load it for this session. Explore some functions.
| |
| − | |> ??install
| |
| − | > ?install.packages
| |
| − | > install.packages("seqinr")
| |
| − | --- Please select a CRAN mirror for use in this session ---
| |
| − | trying URL 'http://probability.ca/cran/bin/macosx/contrib/2.13/seqinr_3.0-5.tgz'
| |
| − | Content type 'application/x-gzip' length 4528528 bytes (4.3 Mb)
| |
| − | opened URL
| |
| − | ==================================================
| |
| − | downloaded 4.3 Mb
| |
| − |
| |
| − |
| |
| − | The downloaded packages are in
| |
| − | /var/folders/dq/dqPEEPbF0ApRU/-Tmp-//RtmpBlw/downloaded_packages
| |
| − | >
| |
| − | > library("seqinr")
| |
| − | > ls("package:seqinr")
| |
| − | [1] "a" "aaa" "AAstat"
| |
| − | [4] "acnucclose" "acnucopen" "al2bp"
| |
| − | [...]
| |
| − | [205] "where.is.this.acc" "words" "words.pos"
| |
| − | [208] "write.fasta" "zscore"
| |
| − | > ?a
| |
| − | > a("Tyr")
| |
| − | [1] "Y"
| |
| − | > choosebank()
| |
| − | [1] "genbank" "embl" "emblwgs" "swissprot" "ensembl"
| |
| − | [...]
| |
| − | [31] "refseqViruses"
| |
| − | }}
| |
| − |
| |
| − | * The fact that these methods work shows that the library has been downloaded, installed and downloaded and its functions are now available. Just for fun and demonstration, let's use these functions to download a sequence and calculate some statistics (however, not to digress too far, without further explanation at this point). Copy the code below and paste it into the '''R'''-console
| |
| − |
| |
| − | <source lang="rsplus">
| |
| − | choosebank("swissprot")
| |
| − | query("seq", "N=MBP1_YEAST")
| |
| − | mbp1 <- getSequence(seq)
| |
| − | closebank()
| |
| − | x <- AAstat(mbp1[[1]])
| |
| − | barplot(sort(x$Compo))
| |
| − | </source>
| |
| − |
| |
| − | }}
| |
| − |
| |
| − | ===Scripts===
| |
| − |
| |
| − | My preferred way of running '''R''' is not strictly through the console. I open a new file - a script - and enter my '''R''' commands into the file. Then I execute the commands directly from the script. I may try things in the console, experiment, change parameters etc. - but ultimately everything I do goes into the file. This has four major advantages:
| |
| − |
| |
| − | * The script is an accurate record of my procedure so I know exactly what I have done;
| |
| − | * I add numerous comments to record what I was thinking when I developed it;
| |
| − | * I can immediately reproduce the entire analysis from start and finish, simply by rerunning the script;
| |
| − | * I can reuse parts easily, thus making new analyses quick to develop.
| |
| − |
| |
| − | {{task|
| |
| − | * Use the ''File'' menu to open a ''New Document''.
| |
| − | * Enter the following code (copy from here and paste):
| |
| − | <source lang="rsplus">
| |
| − | # sample script:
| |
| − | # define a vector
| |
| − | a <- c(1, 1, 2, 3, 5, 8, 13)
| |
| − | # list its contents
| |
| − | a
| |
| − | # calculate the mean of its values
| |
| − | mean(a)
| |
| − |
| |
| − | </source>
| |
| − | * save the file in your working directory (e.g. with the name <code>sample.R</code>).
| |
| − |
| |
| − | Placing the cursor in a line and pressing <code>command-return</code> (on the Mac, <code>ctrl-r</code> on Windows) will execute that line and you see the result on the console. You can also select more than one line and execute the selected block with this shortcut. Alternatively, you can run the entire file. In the console type:
| |
| − |
| |
| − | <source lang="rsplus">
| |
| − | source("sample.R")
| |
| − | </source>
| |
| − |
| |
| − | However: this will not print output to the console. When you run a script, if you want to see text output you need to explicitly <code>print( )</code> it.
| |
| − |
| |
| − | *Change your script to the following, save it and <code>source( )</code> it.
| |
| − | <source lang="rsplus">
| |
| − | # sample script:
| |
| − | # define a vector
| |
| − | a <- c(1, 1, 2, 3, 5, 8, 13)
| |
| − | # list its contents
| |
| − | print(a)
| |
| − | # calculate the mean of its values
| |
| − | print(mean(a))
| |
| − |
| |
| − | </source>
| |
| − |
| |
| − | * Confirm that the <code>print(a)</code> command also works when you execute the line directly from the script.
| |
| − |
| |
| − | }}
| |
| − |
| |
| − | Nb. if you want to save your output to file, you can divert it to a file with the <code>sink( )</code> command. You can read about the command by typing:
| |
| − |
| |
| − | <source lang="rsplus">
| |
| − | ?sink
| |
| − | </source>
| |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| − | ==Simple commands==
| |
| − | Including functions
| |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| − | ==Scalar datatypes==
| |
| − | Definition, change, operations with, functions to work on...
| |
| − |
| |
| − |
| |
| − | ==Vectors==
| |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| − | ==Matrices, tables, frames==
| |
| − |
| |
| − | Subsetting,mselecting and filtering
| |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| − | ==Data manipulations==
| |
| − | Transformation
| |
| − | Search
| |
| − |
| |
| − |
| |
| − |
| |
| − | ==Writing functions==
| |
| − |
| |
| − |
| |
| − |
| |
| − | ==Installing new functions==
| |
| − |
| |
| − |
| |
| − |
| |
| − | ==Numeric output==
| |
| − |
| |
| − |
| |
| − |
| |
| − | ==Graphic output==
| |
| − |
| |
| − |
| |
| − |
| |
| − |
| |
| | ==Notes== | | ==Notes== |
| | <references /> | | <references /> |
| | | | |
| | + | |
| | + | {{Vspace}} |
| | | | |
| | | | |
| − |
| + | ---- |
| − | ==Further reading and resources==
| |
| − | <!-- {{#pmid:21627854}} -->
| |
| − | <!-- {{WWW|WWW_UniProt}} -->
| |
| − | <!-- <div class="reference-box">[http://www.ncbi.nlm.nih.gov]</div> -->
| |
| | | | |
| | + | {{Vspace}} |
| | | | |
| − |
| |
| | [[Category:Applied_Bioinformatics]] | | [[Category:Applied_Bioinformatics]] |
| | + | [[Category:R]] |
| | </div> | | </div> |
