Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
PyFastANI
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Martin Larralde
PyFastANI
Commits
507020f9
Commit
507020f9
authored
2 years ago
by
Martin Larralde
Browse files
Options
Downloads
Patches
Plain Diff
Improve some parts of the `pyfastani` class documentation
parent
32525ab4
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
pyfastani/_fastani.pyx
+19
-4
19 additions, 4 deletions
pyfastani/_fastani.pyx
with
19 additions
and
4 deletions
pyfastani/_fastani.pyx
+
19
−
4
View file @
507020f9
...
...
@@ -363,6 +363,10 @@ cdef class _Parameterized:
cdef
class
Sketch
(
_Parameterized
):
"""
An index computing minimizers over the reference genomes.
Use this class to add reference genomes with the `add_genome` or
`add_draft` methods, then call the `index` method to obtain a `Mapper`
that can be used to map query genomes.
Attributes:
minimizers (`~pyfastani.Minimizers`): A view over the minimizers
currently recorded in the sketch.
...
...
@@ -400,7 +404,7 @@ cdef class Sketch(_Parameterized):
uint64_t
reference_size
=
5_000_000
,
bint
protein
=
False
,
):
f
"""
__init__(self, *, k=16, fragment_length=3000, minimum_fraction=0.2, p_value=1e-03, percentage_identity=80, reference_size=5
000000
, protein=False)
\n
--
"""
__init__(self, *, k=16, fragment_length=3000, minimum_fraction=0.2, p_value=1e-03, percentage_identity=80, reference_size=5
e9
, protein=False)
\n
--
Create a new FastANI sequence sketch.
...
...
@@ -1072,8 +1076,8 @@ cdef class Mapper(_Parameterized):
Query the mapper for a complete genome.
Arguments:
sequence (`str` or `bytes`): The genome to query the
mapper
with.
sequence (`str` or `bytes`): The
closed
genome to query the
mapper
with.
Returns:
`list` of `~pyfastani.Hit`: The hits found for the query.
...
...
@@ -1162,7 +1166,18 @@ cdef class Minimizers:
cdef
class
Hit
:
"""
A single hit found when querying the mapper with a genome.
"""
A single hit found when querying a `Mapper` with a genome.
Attributes:
name (`object`): The name of the genome that produced a hit, as
given to `Sketch.add_genome` or `Sketch.add_draft`.
matches (`int`): The number of fragments that matched the target
genome.
fragments (`int`): The total number of fragments used to compare
the query and target genomes.
identity (`float`): The average nucleotide identity between the
two genomes, given as a percentage.
"""
# --- Attributes ---------------------------------------------------------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment