Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
ff5ea1c
Material design SVG icons instead of PNG
ewels Aug 12, 2025
dd99dd5
Playing with refreshed sidebar style
ewels Aug 12, 2025
8a77c32
Rename header template to .CSS, create new scaffold HTML template
ewels Aug 23, 2025
493b519
Move more HTML out of the .java file and into file fragments
ewels Aug 23, 2025
897ecc7
Clean up CSS file, remove @screen stuff and remove duplicates
ewels Aug 23, 2025
d581293
Restructure report
ewels Aug 23, 2025
df973cf
Basic stats - look like a definition list (CSS only)
ewels Aug 24, 2025
cebd4d4
Basic stats: revert to table, but keep clean styling
ewels Aug 25, 2025
e7f3662
New FastQC icon
ewels Aug 25, 2025
90c8a27
Use SVG icon instead of PNG
ewels Aug 25, 2025
b84b5fe
Remove old PNG images from HTML report template Icons folder
ewels Aug 25, 2025
cde0ade
Remove legacy unused stylesheet file
ewels Aug 25, 2025
1abc0c4
Remove image indent. Ensure width doesn't overflow viewport.
ewels Aug 25, 2025
85e9116
Start cleaning up CSS
ewels Aug 25, 2025
fdb478b
Mobile nav: animate from top, not side. Fix scroll-top values.
ewels Aug 25, 2025
08b0bc8
Embed help text into HTML report
ewels Aug 25, 2025
4b2503d
Sentence case titles
ewels Aug 25, 2025
db65e05
Clean up CSS
ewels Aug 25, 2025
3598917
Cleanup: Remove some orphaned code
ewels Aug 25, 2025
0d76b12
Full logo, dark + light mode. Add to readme.
ewels Aug 25, 2025
3b67ede
h1 for main report title, larger font + icon
ewels Aug 25, 2025
80ae0be
Update .po generation to minimise diff to master
ewels Aug 31, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions Help/3 Analysis Modules/1 Basic Statistics.html
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<html>

<head>
<title>Basic Statistics</title>
<title>Basic statistics</title>
<style type="text/css">
body {
font-family: sans-serif;
}
</style>
</head>
<body>
<h1>Basic Statistics</h1>
<h1>Basic statistics</h1>
<h2>Summary</h2>
<p>
The Basic Statistics module generates some simple composition
The Basic statistics module generates some simple composition
statistics for the file analysed.
</p>

Expand All @@ -21,14 +21,14 @@ <h2>Summary</h2>
<li>File type: Says whether the file appeared to contain actual base calls or
colorspace data which had to be converted to base calls</li>
<li>Encoding: Says which ASCII encoding of quality values was found in this
file.
</li><li>Total Sequences: A count of the total number of sequences processed.
file.</li>
<li>Total Sequences: A count of the total number of sequences processed.
There are two values reported, actual and estimated. At the moment these
will always be the same. In the future it may be possible to analyse just
a subset of sequences and estimate the total number, to speed up the analysis,
but since we have found that problematic sequences are not evenly distributed
through a file we have disabled this for now.</li>
<li>Filtered Sequences: If running in Casava mode sequences flagged to be
<li>Filtered Sequences: If running in Casava mode sequences flagged to be
filtered will be removed from all analyses. The number of such sequences
removed will be reported here. The total sequences count above will not include
these filtered sequences and will the number of sequences actually used for the
Expand All @@ -41,12 +41,12 @@ <h2>Summary</h2>

<h2>Warning</h2>
<p>
Basic Statistics never raises a warning.
Basic statistics never raises a warning.
</p>

<h2>Failure</h2>
<p>
Basic Statistics never raises an error.
Basic statistics never raises an error.
</p>

<h2>Common reasons for warnings</h2>
Expand Down
22 changes: 11 additions & 11 deletions Help/3 Analysis Modules/10 Adapter Content.html
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
<html>

<head>
<title>Adapter Content</title>
<title>Adapter content</title>
<style type="text/css">
body {
font-family: sans-serif;
}
</style>
</head>
<body>
<h1>Adapter Content</h1>
<h1>Adapter content</h1>
<h2>Summary</h2>
<p>
The Kmer Content module will do a generic analysis of all of the Kmers
in your library to find those which do not have even coverage through
in your library to find those which do not have even coverage through
the length of your reads. This can find a number of different sources
of bias in the library which can include the presence of read-through
adapter sequences building up on the end of your sequences.
Expand All @@ -26,15 +26,15 @@ <h2>Summary</h2>
be interested.
</p>
<p>
One obvious class of sequences which you might want to analyse are
adapter sequences. It is useful to know if your library contains a
significant amount of adapter in order to be able to assess whether
you need to adapter trim or not. Although the Kmer analysis can
One obvious class of sequences which you might want to analyse are
adapter sequences. It is useful to know if your library contains a
significant amount of adapter in order to be able to assess whether
you need to adapter trim or not. Although the Kmer analysis can
theoretically spot this kind of contamination it isn't always clear.
This module therefore does a specific search for a set of separately
defined Kmers and will give you a view of the total proportion of your
library which contain these Kmers. A results trace will always be
generated for all of the sequences present in the adapter config file
library which contain these Kmers. A results trace will always be
generated for all of the sequences present in the adapter config file
so you can see the adapter content of your library, even if it's low.
</p>
<p>
Expand All @@ -48,7 +48,7 @@ <h2>Summary</h2>
In addition to classic adapter sequences the default configuration also
includes polyA and polyG as sequences to search for. PolyA can be useful
to include when looking at RNA-Seq libraries. PolyG is present as a
technical artefact in 2-colour illumina libraries where it is produced
technical artefact in 2-colour illumina libraries where it is produced
when the signal from the cluster disappears. Both of these sequences
are generally trimmed from the 3' end of sequences, and are therefore
removed in a similar way to adapters, hence their inclusion in the default
Expand All @@ -71,7 +71,7 @@ <h2>Failure</h2>
<h2>Common reasons for warnings</h2>
<p>
Any library where a reasonable proportion of the insert sizes are shorter
than the read length will trigger this module. This doesn't indicate a
than the read length will trigger this module. This doesn't indicate a
problem as such - just that the sequences will need to be adapter trimmed
before proceeding with any downstream analysis.
</p>
Expand Down
29 changes: 15 additions & 14 deletions Help/3 Analysis Modules/4 Per Base Sequence Content.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ <h2>Summary</h2>
</p>
<p>
It's worth noting that some types of library will always produce biased
sequence composition, normally at the start of the read. Libraries
sequence composition, normally at the start of the read. Libraries
produced by priming using random hexamers (including nearly all RNA-Seq libraries)
and those which were fragmented using transposases inherit an intrinsic
bias in the positions at which reads start. This bias does not concern
an absolute sequence, but instead provides enrichement of a number of
bias in the positions at which reads start. This bias does not concern
an absolute sequence, but instead provides enrichement of a number of
different K-mers at the 5' end of the reads. Whilst this is a true
technical bias, it isn't something which can be corrected by trimming
and in most cases doesn't seem to adversely affect the downstream analysis.
Expand All @@ -52,34 +52,35 @@ <h2>Failure</h2>

<h2>Common reasons for warnings</h2>
<p>
There are a number of common scenarios which would ellicit a warning
There are a number of common scenarios which would ellicit a warning
or error from this module.
</p>

<ol>
<li>Overrepresented sequences: If there is any evidence of overrepresented
sequences such as adapter dimers or rRNA in a sample then these sequences
may bias the overall composition and their sequence will emerge from this plot.
sequences such as adapter dimers or rRNA in a sample then these sequences
may bias the overall composition and their sequence will emerge from this plot.</li>
<li>Biased fragmentation: Any library which is generated based on the ligation
of random hexamers or through tagmentation should theoretically have good
diversity through the sequence, but experience has shown that these libraries
diversity through the sequence, but experience has shown that these libraries
always have a selection bias in around the first 12bp of each run. This is
due to a biased selection of random primers, but doesn't represent any individually
biased sequences. Nearly all RNA-Seq libraries will fail this module because of
this bias, but this is not a problem which can be fixed by processing, and it
doesn't seem to adversely affect the ablity to measure expression.
this bias, but this is not a problem which can be fixed by processing, and it
doesn't seem to adversely affect the ablity to measure expression.</li>
<li>Biased composition libraries: Some libraries are inherently biased in their
sequence composition. The most obvious example would be a library which has been
sequence composition. The most obvious example would be a library which has been
treated with sodium bisulphite which will then have converted most of the cytosines
to thymines, meaning that the base composition will be almost devoid of cytosines
to thymines, meaning that the base composition will be almost devoid of cytosines
and will thus trigger an error, despite this being entirely normal for that type of
library</li>
<li>If you are analysing a library which has been aggressivley adapter trimmed
then you will naturally introduce a composition bias at the end of the reads as
sequences which happen to match short stretches of adapter are removed, leaving
<li>If you are analysing a library which has been aggressivley adapter trimmed
then you will naturally introduce a composition bias at the end of the reads as
sequences which happen to match short stretches of adapter are removed, leaving
only sequences which do not match. Sudden deviations in composition at the end
of libraries which have undergone aggressive trimming are therefore likely to be
spurious.</li>
</ol>

</body>
</html>
12 changes: 6 additions & 6 deletions Help/3 Analysis Modules/6 Per Base N Content.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ <h1>Per Base N Content</h1>
<h2>Summary</h2>
<p>
If a sequencer is unable to make a base call with sufficient confidence
then it will normally substitute an N rather than a conventional base]
then it will normally substitute an N rather than a conventional base
call
</p>
<p>
Expand All @@ -23,7 +23,7 @@ <h2>Summary</h2>
<p><img src="per_base_n_content.png"></p>

<p>
It's not unusual to see a very low proportion of Ns appearing in a sequence,
It's not unusual to see a very low proportion of Ns appearing in a sequence,
especially nearer the end of a sequence. However, if this proportion rises
above a few percent it suggests that the analysis pipeline was unable to
interpret the data well enough to make valid base calls.
Expand All @@ -43,15 +43,15 @@ <h2>Common reasons for warnings</h2>
<p>
The most common reason for the inclusion of significant proportions of Ns
is a general loss of quality, so the results of this module should be evaluated
in concert with those of the various quality modules. You should check the
in concert with those of the various quality modules. You should check the
coverage of a specific bin, since it's possible that the last bin in this analysis
could contain very few sequences, and an error could be prematurely triggered in
could contain very few sequences, and an error could be prematurely triggered in
this case.
</p>
<p>
Another common scenario is the incidence of a high proportions of N at a small
number of positions early in the library, against a background of generally
good quality. Such deviations can occur when you have very biased sequence
number of positions early in the library, against a background of generally
good quality. Such deviations can occur when you have very biased sequence
composition in the library to the point that base callers can become confused
and make poor calls. This type of problem will be apparent when looking at the
per-base sequence content results.
Expand Down
8 changes: 4 additions & 4 deletions Help/3 Analysis Modules/7 Sequence Length Distribution.html
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
<html>

<head>
<title>Sequence Length Distribution</title>
<title>Sequence length distribution</title>
<style type="text/css">
body {
font-family: sans-serif;
}
</style>
</head>
<body>
<h1>Sequence Length Distribution</h1>
<h1>Sequence length distribution</h1>
<h2>Summary</h2>
<p>
Some high throughput sequencers generate sequence fragments
of uniform length, but others can contain reads of wildly
varying lengths. Even within uniform length libraries some
pipelines will trim sequences to remove poor quality base calls
varying lengths. Even within uniform length libraries some
pipelines will trim sequences to remove poor quality base calls
from the end.
</p>
<p>
Expand Down
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# FastQC
<h1>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="uk/ac/babraham/FastQC/Resources/fastqc_logo_darkbg.svg">
<source media="(prefers-color-scheme: light)" srcset="uk/ac/babraham/FastQC/Resources/fastqc_logo.svg">
<img src="uk/ac/babraham/FastQC/Resources/fastqc_logo.svg" alt="FastQC">
</picture>
</h1>

**A Quality Control application for FastQ files**

Expand All @@ -23,16 +29,24 @@ FastQC is an application which takes a FastQ file and runs a series of tests on
FastQC can be run either as an interactive graphical application which allows you to view results for multiple files in a single application. Alternatively you can run the program in a non interactive way (say as part of a pipeline) which will generate an HTML report for each file you process.

FastQC is a cross-platform application, written in java. In theory it should run on any platform which has a suitable java runtime environment.
Having said that we've only tested in on Windows, MacOSX and Linux running the Oracle v1.6 to 1.8 JREs. Please let us know what happened if you try running it on other platforms / JREs. Please see the detailed instructions in the INSTALL.txt document to tell you how to get a suitable java version to run FastQC on your system.
Having said that we've only tested in on Windows, MacOSX and Linux running the Oracle v1.6 to 1.8 JREs. Please let us know what happened if you try running it on other platforms / JREs.
Please see the detailed instructions [in `INSTALL.md`](`INSTALL.md`) to tell you how to get a suitable java version to run FastQC on your system.

## Installation

Please see the [**project web page**](http://www.bioinformatics.babraham.ac.uk/projects/fastqc/) and the [installation instructions](INSTALL.md) in this repository.

## Contributions

If you have any comments about FastQC we would like to hear them. You can either enter them into the github bug tracker at:
If you have any comments about FastQC we would like to hear them.
You can either create a [GitHub issue](https://github.com/s-andrews/FastQC/issues/) or send them directly to [email protected].

https://github.com/s-andrews/FastQC/issues/
FastQC was written by Simon Andrews, at the Babraham Institute, Cambridge, UK.

..or send them directly to [email protected].
https://www.bioinformatics.babraham.ac.uk/

<picture>
<source media="(prefers-color-scheme: dark)" srcset="uk/ac/babraham/FastQC/Resources/babraham_darkbg.svg">
<source media="(prefers-color-scheme: light)" srcset="uk/ac/babraham/FastQC/Resources/babraham.svg">
<img src="uk/ac/babraham/FastQC/Resources/babraham.svg" alt="Babraham Institute" width=100>
</picture>
Binary file removed Templates/Icons/error.png
Binary file not shown.
3 changes: 3 additions & 0 deletions Templates/Icons/error.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed Templates/Icons/fastqc_icon.png
Binary file not shown.
47 changes: 47 additions & 0 deletions Templates/Icons/fastqc_icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions Templates/Icons/pass.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed Templates/Icons/tick.png
Binary file not shown.
Binary file removed Templates/Icons/warning.png
Binary file not shown.
3 changes: 3 additions & 0 deletions Templates/Icons/warning.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading