Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor interface to RCSB search API #466

Merged
merged 8 commits into from
Mar 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions doc/apidoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@
"MotifQuery",
"StructureQuery"
],
"Sorting and grouping" : [
"Sorting",
"Grouping",
"DepositGrouping",
"IdentityGrouping",
"UniprotGrouping"
],
"Search and fetch" : [
"count",
"search",
Expand Down
24 changes: 24 additions & 0 deletions doc/tutorial/src/database.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,30 @@
print(rcsb.search(composite_query))

########################################################################
# Often the structures behind the obtained PDB IDs have degree of
# redundancy.
# For example they may represent the same protein sequences or result
# from the same set of experiments.
# You may use :class:`Grouping` of structures to group redundant
# entries or even return only single representatives of each group.

query = rcsb.BasicQuery("Transketolase")
# Group PDB IDs from the same collection
print(rcsb.search(
query, group_by=rcsb.DepositGrouping(), return_groups=True
))
# Get only a single representative of each group
print(rcsb.search(
query, group_by=rcsb.DepositGrouping(), return_groups=False
))

########################################################################
# Note that grouping may omit PDB IDs in search results, if such PDB IDs
# cannot be grouped.
# In the example shown above, not all structures
# For example in the case shown above only a few PDB entries were
# uploaded as collection and hence are part of the search results.
#
# Fetching files from the NCBI Entrez database
# --------------------------------------------
#
Expand Down
10 changes: 0 additions & 10 deletions src/biotite/application/viennarna/rnafold.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,16 +174,6 @@ def get_mfe(self):
-------
mfe : float
The minimum free energy.

Examples
--------

>>> sequence = NucleotideSequence("CGACGTAGATGCTAGCTGACTCGATGC")
>>> app = RNAfoldApp(sequence)
>>> app.start()
>>> app.join()
>>> print(app.get_mfe())
-1.3
"""
warnings.warn(
"'get_mfe()' is deprecated, use 'get_free_energy()' instead",
Expand Down
Loading