Skip to content

Commit 103a90c

Browse files
authored
Update README.md
1 parent 0601134 commit 103a90c

File tree

1 file changed

+34
-31
lines changed

1 file changed

+34
-31
lines changed

README.md

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -140,49 +140,52 @@ distinct ID.
140140

141141
## Transcripts
142142

143-
`transcripts(contig=None, strand=None)`
144-
: returns list of Transcript objects for all transcript entries in the
145-
Ensembl database, optionally restricted to a particular contig or strand.
143+
<dl>
144+
<dt>`transcripts(contig=None, strand=None)`</dt>
145+
<dd>Returns a list of Transcript objects for all transcript entries in the
146+
Ensembl database, optionally restricted to a particular contig or strand.</dd>
146147

147-
`transcript_by_id(transcript_id)`
148-
: construct Transcript object for given Ensembl transcript ID (e.g. "ENST00000369985")
148+
<dt>`transcript_by_id(transcript_id)`</dt>
149+
<dd>Construct a Transcript object for given Ensembl transcript ID (e.g. "ENST00000369985")</dd>
149150

150-
`transcripts_by_name(transcript_name)`
151-
: returns list of Transcript objects for every transcript matching the given name.
151+
<dt>`transcripts_by_name(transcript_name)`</dt>
152+
<dd>Returns a list of Transcript objects for every transcript matching the given name.</dd>
152153

153-
`transcript_names(contig=None, strand=None)`
154-
: all transcript names in the annotation database
154+
<dt>`transcript_names(contig=None, strand=None)`</dt>
155+
<dd>Returns all transcript names in the annotation database.</dd>
155156

156-
`transcript_ids(contig=None, strand=None)`
157-
: returns all transcript IDs in the annotation database
157+
<dt>`transcript_ids(contig=None, strand=None)`</dt>
158+
<dd>Returns all transcript IDs in the annotation database.</dd>
158159

159-
`transcript_ids_of_gene_id(gene_id)`
160-
: return IDs of all transcripts associated with given gene ID
160+
<dt>`transcript_ids_of_gene_id(gene_id)`</dt>
161+
<dd>Return IDs of all transcripts associated with given gene ID.</dd>
161162

162-
`transcript_ids_of_gene_name(gene_name)`
163-
: return IDs of all transcripts associated with given gene name
163+
<dt>`transcript_ids_of_gene_name(gene_name)`</dt>
164+
<dd>Return IDs of all transcripts associated with given gene name.</dd>
164165

165-
`transcript_ids_of_transcript_name(transcript_name)`
166-
: find all Ensembl transcript IDs with the given name
167-
168-
`transcript_ids_of_exon_id(exon_id)`
169-
: return IDs of all transcripts associatd with given exon ID
166+
<dt>`transcript_ids_of_transcript_name(transcript_name)`</dt>
167+
<dd>Find all Ensembl transcript IDs with the given name.</dd>
170168

169+
<dt>`transcript_ids_of_exon_id(exon_id)`</dt>
170+
<dd>Return IDs of all transcripts associatd with given exon ID.</dd>
171+
</d>
171172

172173
## Exons
173174

174-
`exon_ids(contig=None, strand=None)`
175-
: returns list of exons IDs in the annotation database, optionally restricted
176-
by the given chromosome and strand
175+
<dl>
176+
<dt>`exon_ids(contig=None, strand=None)`</dt>
177+
<dd>Returns a list of exons IDs in the annotation database, optionally restricted
178+
by the given chromosome and strand.</dd>
177179

178-
`exon_ids_of_gene_id(gene_id)`
179-
: returns list of exon IDs associated with a given gene ID
180+
<dt>`exon_ids_of_gene_id(gene_id)`</dt>
181+
<dd>Returns a list of exon IDs associated with a given gene ID.</dd>
180182

181-
`exon_ids_of_gene_name(gene_name)`
182-
: returns list of exon IDs associated with a given gene name
183+
<dt>`exon_ids_of_gene_name(gene_name)`</dt>
184+
<dd>Returns a list of exon IDs associated with a given gene name.</dd>
183185

184-
`exon_ids_of_transcript_id(transcript_id)`
185-
: returns list of exon IDs associated with a given transcript ID
186+
<dt>`exon_ids_of_transcript_id(transcript_id)`</dt>
187+
<dd>Returns a list of exon IDs associated with a given transcript ID.</dd>
186188

187-
`exon_ids_of_transcript_name(transcript_name)`
188-
: returns list of exon IDs associated with a given transcript name
189+
<dt>`exon_ids_of_transcript_name(transcript_name)`</dt>
190+
<dd>Returns a list of exon IDs associated with a given transcript name.</dd>
191+
</dl>

0 commit comments

Comments
 (0)