Update package documentation to desired format

burgerga · Dec 20, 2023 · f1d659c · f1d659c
1 parent 708b2d1
commit f1d659c
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 27 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -19,7 +19,8 @@ Depends: R (>= 2.10)
 URL: https://github.com/burgerga/mdftracks
 BugReports: https://github.com/burgerga/mdftracks/issues
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.1
+RoxygenNote: 7.2.3
+Config/testthat/edition: 3
 Encoding: UTF-8
 Suggests: 
     testthat,

diff --git a/R/mdftracks-package.R b/R/mdftracks-package.R
@@ -0,0 +1,7 @@
+#' @keywords internal
+#' @seealso [MTrackJ Data Format](https://imagescience.org/meijering/software/mtrackj/format/)
+"_PACKAGE"
+
+## usethis namespace: start
+## usethis namespace: end
+NULL
diff --git a/R/mdftracks.R b/R/mdftracks.R
@@ -1,15 +1,3 @@
-#' mdftracks:  Read and Write MTrackJ Data Files
-#'
-#' Reads and writes MTrackJ Data Files (`.mdf`).
-#' Supports clusters, 2D data, and channel information. If desired, generates
-#' unique track identifiers based on cluster and id data from the `.mdf` file.
-#'
-#' @docType package
-#' @name mdftracks
-#' @seealso [MTrackJ Data Format](https://imagescience.org/meijering/software/mtrackj/format/)
-NULL
-
-
 # Store package local variables
 pkg.env <- new.env(parent = emptyenv())
 pkg.env$mtrackj.version <- '1.5.1'

diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -4,3 +4,5 @@ MTrackJ
 celltrackR
 codecov
 mdf
+DOI
+ORCID
diff --git a/man/mdftracks-package.Rd b/man/mdftracks-package.Rd
diff --git a/man/mdftracks.Rd b/man/mdftracks.Rd
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,3 +4,5 @@ MTrackJ @@
     celltrackR
     codecov
     mdf
+    DOI
+    ORCID