Add some info to README

camilogarciabotero · Aug 19, 2024 · b3f03c0 · b3f03c0
1 parent d4de73e
commit b3f03c0
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -95,6 +95,18 @@ countatoms(lambdaprotein)
   50  110  10  20  0  # V (Val)
 ```
 
+Sometimes what is needed is the total number of each atom in the sequence. This can be achieved by a simple sum of the matrix:
+
+```julia
+counts = countatoms(lambdaprotein)
+
+sum(counts, dims=1)
+
+1×5 Matrix{Int64}:
+#  C     H     N   O  S
+ 895  1814  270  449  4
+```
+
 ## License
 
 MIT License

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -66,6 +66,18 @@ countatoms(lambdaprotein)
   50  110  10  20  0  # V (Val)
 ```
 
+Sometimes what is needed is the total number of each atom in the sequence. This can be achieved by a simple sum of the matrix:
+
+```julia
+counts = countatoms(lambdaprotein)
+
+sum(counts, dims=1)
+
+1×5 Matrix{Int64}:
+#  C     H     N   O  S
+ 895  1814  270  449  4
+```
+
 ## License
 
 MIT License