Skip to content

Commit

Permalink
bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
jgreener64 committed Sep 29, 2020
1 parent f16e689 commit cbdb7df
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 9 deletions.
5 changes: 5 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
BioStructures.jl release notes
==============================

## v0.11.4 - Sep 2020

* A `ProteinStructure` can now be obtained from a `MMCIFDict` or `MMTFDict` by passing them to the `ProteinStructure` constructor. This saves having to read the file twice when both the dictionary and the structure object are required.
* Add `get` method for `MMTFDict`.

## v0.11.3 - Sep 2020

* Gzip support is added for reading and writing mmCIF files via the `gzip` keyword argument.
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "BioStructures"
uuid = "de9282ab-8554-53be-b2d6-f6c222edabfc"
authors = ["Joe G Greener <[email protected]>"]
version = "0.11.3"
version = "0.11.4"

[deps]
BioAlignments = "00701ae9-d1dc-5365-b64a-a3a3ebf5695e"
Expand Down
16 changes: 8 additions & 8 deletions docs/src/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ MMTF files can be read into the same data structure with `read("/path/to/mmtf/fi
The keyword argument `gzip`, default `false`, determines if the file is gzipped.
In a similar manner to mmCIF dictionaries, a MMTF file can be read into a dictionary with [`MMTFDict`](@ref).
The values of the dictionary are a variety of types depending on the [MMTF specification](https://github.com/rcsb/mmtf/blob/master/spec.md).
To convert a [`MMCIFDict`](@ref) or [`MMTFDict`](@ref) to the Structure-Model-Chain-Residue-Atom framework, use the `ProteinStructure` constructor, e.g. `ProteinStructure(mmcif_dict)`.
To convert a [`MMCIFDict`](@ref) or [`MMTFDict`](@ref) to the Structure-Model-Chain-Residue-Atom framework, use the [`ProteinStructure`](@ref) constructor, e.g. `ProteinStructure(mmcif_dict)`.

The elements of `struc` can be accessed as follows:

Expand Down Expand Up @@ -456,13 +456,13 @@ ProteinStructure 1EN2.pdb with 1 models, 1 chains (A), 85 residues, 754 atoms
Read a mmCIF/MMTF file instead by replacing [`PDB`](@ref) with [`MMCIF`](@ref)/[`MMTF`](@ref).
Various options can be set through optional keyword arguments when parsing PDB/mmCIF/MMTF files:

| Keyword Argument | Description |
| :------------------------------- | :--------------------------------------------------------------------------- |
| `structure_name::AbstractString` | The name given to the returned `ProteinStructure`; defaults to the file name |
| `remove_disorder::Bool=false` | Whether to remove atoms with alt loc ID not ' ' or 'A' |
| `read_std_atoms::Bool=true` | Whether to read standard ATOM records |
| `read_het_atoms::Bool=true` | Whether to read HETATOM records |
| `gzip::Bool=false` | Whether the file is gzipped (MMTF and mmCIF files only) |
| Keyword Argument | Description |
| :------------------------------- | :----------------------------------------------------------------------------------- |
| `structure_name::AbstractString` | The name given to the returned [`ProteinStructure`](@ref); defaults to the file name |
| `remove_disorder::Bool=false` | Whether to remove atoms with alt loc ID not ' ' or 'A' |
| `read_std_atoms::Bool=true` | Whether to read standard ATOM records |
| `read_het_atoms::Bool=true` | Whether to read HETATOM records |
| `gzip::Bool=false` | Whether the file is gzipped (MMTF and mmCIF files only) |

Use [`retrievepdb`](@ref) to download and parse a PDB file into a Structure-Model-Chain-Residue-Atom framework in a single line:

Expand Down

2 comments on commit cbdb7df

@jgreener64
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/22170

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.11.4 -m "<description of version>" cbdb7df2fd33eb6d24a1aba75b5d71defe3ef1e3
git push origin v0.11.4

Please sign in to comment.