add package title and description

jefferislab · Jul 15, 2024 · 8aa1610 · 8aa1610
1 parent 08be31e
commit 8aa1610
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 7 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,11 +1,15 @@
 Package: racq4
 Type: Package
-Title: What the Package Does (Title Case)
+Title: Analysis of acq4 electrophysiology data
 Version: 0.1.0
-Author: Who wrote it
-Maintainer: The package maintainer <[email protected]>
-Description: More about what it does (maybe more than one line)
-    Use four spaces when indenting paragraphs within the Description.
+Authors@R: c(
+    person("Shahar","Frechter", email="[email protected]", 
+    role = c("aut", "cre"), comment = c(ORCID = "0000-0002-0431-5849")),
+    person("Gregory","Jefferis", email="[email protected]", 
+    role = c("aut"), comment = c(ORCID = "0000-0002-0587-9355")))
+Description: Functions to analyse acq4 electrophysiology data in its native HDF5
+    format including, reading (with attributes), downsampling, smoothing, spike
+    finding and plotting.
 License: GPL (>= 3)
 Encoding: UTF-8
 LazyData: true

diff --git a/man/racq4-package.Rd b/man/racq4-package.Rd