Skip to content

Commit 0de9118

Browse files
committed
update file-formats docs with links
External links to other resources with file format specification information are added to avoid having to describe all the file formats. The internal links were all updated to match latest docusaurus standard format.
1 parent a08b95e commit 0de9118

1 file changed

Lines changed: 60 additions & 56 deletions

File tree

docusaurus/docs/file-formats.md

Lines changed: 60 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ title: File Formats
44
sidebar_label: File Formats
55
---
66

7-
A variety of standard file formats including BAM/GFF/BED/CDT are used by the ScriptManager tools along with some custom file formats. Below is some info on the expected formats and specifications of the files used by ScriptManager.
8-
9-
| |
10-
| ------------- | ------------- | ------------- |
11-
| [BAM][bam-format] | [CDT][cdt-format] | [GFF][gff-format] |
12-
| [BED][bed-format] | [FASTA][fasta-format] | [PNG][png-format] |
7+
A variety of standard file formats including BAM, GFF, BED, and [CDT][cdt-format] are used by the ScriptManager tools along with some custom file formats. The purpose of this guide is to help users find tools in ScriptManager based on the format their data exists in.
138

9+
### Read More
10+
While this page includes a little info on each of the file formats, there are other resources on the internet that provide detailed descriptions and context that will better inform users looking for more explanation on the data formats (see links below).
11+
- [UCSC file formats guide][ucsc-file-formats]
12+
- [ENCODE file formats guide][encode-file-formats]
13+
- [Deeptools file formats guide][encode-file-formats]
1414

1515
## BAM
1616

@@ -60,7 +60,7 @@ Related Tools:
6060
| [`tag-pileup`][tag-pileup] | |
6161

6262

63-
## bedgraph
63+
## bedGraph
6464

6565
Related Tools:
6666

@@ -126,7 +126,7 @@ Related Tools:
126126

127127
## Matrix format (custom for these tools)
128128

129-
The output from [TagPileup][read-analysis] is the format for the matrix format
129+
The output from [TagPileup][tag-pileup] is the format for the matrix format
130130

131131
Related Tools:
132132

@@ -159,8 +159,6 @@ Related Tools:
159159
| ------------- | ------------- |
160160
| [`bam-to-scidx`][bam-to-scidx] | |
161161

162-
[bam-specs]:https://samtools.github.io/hts-specs/
163-
[gff-specs]:https://useast.ensembl.org/info/website/upload/gff3.html
164162

165163

166164
## TXT
@@ -215,49 +213,55 @@ Related Tools:
215213
[`tag-pileup`][tag-pileup]
216214
[`tile-genome`][tile-genome]
217215

218-
[bam-format]:file-formats.md
219-
[bed-format]:file-formats.md
220-
[bedgraph-format]:file-formats.md
221-
[gff-format]:file-formats.md
222-
[fasta-format]:file-formats.md
223-
[cdt-format]:file-formats.md
224-
[png-format]:file-formats.md
225-
[scidx-format]:file-formats.md
226-
227-
[aggregate-data]:read-analysis/aggregate-data.md
228-
[bam-correlation]:bam-statistics/bam-correlation.md
229-
[bam-indexer]:bam-manipulation/bam-indexer.md
230-
[bam-to-bedgraph]:bam-format-converter/bam-to-bedgraph.md
231-
[bam-to-bed]:bam-format-converter/bam-to-bed.md
232-
[bam-to-gff]:bam-format-converter/bam-to-gff.md
233-
[bam-to-scidx]:bam-format-converter/bam-to-scidx.md
234-
[bed-to-gff]:coordinate-manipulation/bed-to-gff.md
235-
[composite]:figure-generation/composite-plot.md
236-
[dna-shape-bed]:sequence-analysis/dna-shape-bed.md
237-
[dna-shape-fasta]:sequence-analysis/dna-shape-fasta.md
238-
[expand-bed]:coordinate-manipulation/expand-bed.md
239-
[expand-gff]:coordinate-manipulation/expand-gff.md
240-
[fasta-extract]:sequence-analysis/fasta-extract.md
241-
[filter-bed]:peak-analysis/filter-bed.md
242-
[filter-pip-seq]:bam-manipulation/filter-pip-seq.md
243-
[four-color]:figure-generation/four-color.md
244-
[gff-to-bed]:coordinate-manipulation/gff-to-bed.md
245-
[heatmap]:figure-generation/heatmap.md
246-
[md5checksum]:file-utilities/md5checksum.md
247-
[merge-bam]:bam-manipulation/merge-bam.md
248-
[merge-heatmap]:figure-generation/merge-heatmap.md
249-
[pe-stat]:bam-statistics/pe-stat.md
250-
[peak-align-ref]:peak-analysis/peak-align-ref.md
251-
[rand-coord]:peak-analysis/rand-coord.md
252-
[randomize-fasta]:sequence-analysis/randomize-fasta.md
253-
[remove-duplicates]:bam-manipulation/remove-duplicates.md
254-
[scale-matrix]:read-analysis/scale-matrix.md
255-
[scaling-factor]:read-analysis/scaling-factor.md
256-
[se-stat]:bam-statistics/se-stat.md
257-
[search-motif]:sequence-analysis/search-motif.md
258-
[signal-dup]:peak-analysis/signal-dup.md
259-
[sort-bam]:bam-manipulation/sort-bam.md
260-
[sort-bed]:coordinate-manipulation/sort-bed.md
261-
[sort-gff]:coordinate-manipulation/sort-gff.md
262-
[tag-pileup]:read-analysis/tag-pileup.md
263-
[tile-genome]:peak-analysis/tile-genome.md
216+
[deeptools-file-formats]:https://deeptools.readthedocs.io/en/develop/content/help_glossary.html#file-formats
217+
[encode-file-formats]:https://www.encodeproject.org/help/file-formats/
218+
[ucsc-file-formats]:https://genome.ucsc.edu/FAQ/FAQformat.html
219+
[bam-specs]:https://samtools.github.io/hts-specs/
220+
[gff-specs]:https://useast.ensembl.org/info/website/upload/gff3.html
221+
222+
[bam-format]:file-formats#bam
223+
[bed-format]:file-formats#bed
224+
[bedgraph-format]:file-formats#bedgraph
225+
[gff-format]:file-formats#gff
226+
[fasta-format]:file-formats#fasta
227+
[cdt-format]:file-formats#cdt
228+
[png-format]:file-formats#png
229+
[scidx-format]:file-formats#scidx
230+
231+
[aggregate-data]:read-analysis/aggregate-data
232+
[bam-correlation]:bam-statistics/bam-correlation
233+
[bam-indexer]:bam-manipulation/bam-indexer
234+
[bam-to-bedgraph]:bam-format-converter/bam-to-bedgraph
235+
[bam-to-bed]:bam-format-converter/bam-to-bed
236+
[bam-to-gff]:bam-format-converter/bam-to-gff
237+
[bam-to-scidx]:bam-format-converter/bam-to-scidx
238+
[bed-to-gff]:coordinate-manipulation/bed-to-gff
239+
[composite]:figure-generation/composite-plot
240+
[dna-shape-bed]:sequence-analysis/dna-shape-bed
241+
[dna-shape-fasta]:sequence-analysis/dna-shape-fasta
242+
[expand-bed]:coordinate-manipulation/expand-bed
243+
[expand-gff]:coordinate-manipulation/expand-gff
244+
[fasta-extract]:sequence-analysis/fasta-extract
245+
[filter-bed]:peak-analysis/filter-bed
246+
[filter-pip-seq]:bam-manipulation/filter-pip-seq
247+
[four-color]:figure-generation/four-color
248+
[gff-to-bed]:coordinate-manipulation/gff-to-bed
249+
[heatmap]:figure-generation/heatmap
250+
[md5checksum]:file-utilities/md5checksum
251+
[merge-bam]:bam-manipulation/merge-bam
252+
[merge-heatmap]:figure-generation/merge-heatmap
253+
[pe-stat]:bam-statistics/pe-stat
254+
[peak-align-ref]:peak-analysis/peak-align-ref
255+
[rand-coord]:peak-analysis/rand-coord
256+
[randomize-fasta]:sequence-analysis/randomize-fasta
257+
[remove-duplicates]:bam-manipulation/remove-duplicates
258+
[scale-matrix]:read-analysis/scale-matrix
259+
[scaling-factor]:read-analysis/scaling-factor
260+
[se-stat]:bam-statistics/se-stat
261+
[search-motif]:sequence-analysis/search-motif
262+
[signal-dup]:peak-analysis/signal-dup
263+
[sort-bam]:bam-manipulation/sort-bam
264+
[sort-bed]:coordinate-manipulation/sort-bed
265+
[sort-gff]:coordinate-manipulation/sort-gff
266+
[tag-pileup]:read-analysis/tag-pileup
267+
[tile-genome]:peak-analysis/tile-genome

0 commit comments

Comments
 (0)