Skip to content

Commit

Permalink
Update description to comply with CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
nvelden committed Dec 19, 2024
1 parent 7173fc9 commit 3d62830
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 12 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,6 @@
^revdep$
^cran-comments\.md$
^docs$
^CRAN-SUBMISSION$
^inst/doc/*.R
^inst/doc/*.Rmd
17 changes: 9 additions & 8 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@ Package: geneviewer
Type: Package
Title: Gene Cluster Visualizations in R
Version: 0.1.9
Author: Niels van der Velden
Authors@R: person(given = "Niels",
family = "van der Velden",
role = c("aut", "cre"),
email = "[email protected]")
Maintainer: Niels van der Velden <[email protected]>
Description: 'geneviewer' is an R package for plotting gene clusters and
transcripts.It imports data from GenBank, FASTA, and GFF files,
performs BlastP and MUMmer alignments, and displays results on
gene arrow maps. The package offers extensive customization
options, including legends, labels, annotations, scales,
colors, tooltips, and more.
Description: Provides tools for plotting gene clusters and transcripts by
importing data from GenBank, FASTA, and GFF files. It performs BlastP and
MUMmer alignments and displays results on gene arrow maps. Extensive
customization options are available, including legends, labels, annotations,
scales, colors, tooltips, and more.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
Expand All @@ -34,5 +36,4 @@ Suggests:
pwalign,
Biostrings,
testthat (>= 3.0.0)
VignetteBuilder: knitr
Config/testthat/edition: 3
11 changes: 7 additions & 4 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
19.12.2024

## Submission comments

* Added the `Authors@R` field in the DESCRIPTION file to comply with CRAN requirements.
* Revised the `Description` field in the DESCRIPTION file to avoid starting with the package name or phrases like 'This package'.

## Test environments
* macOS (macos-latest), R devel (via GitHub Actions)
* Windows (windows-latest), R devel (via GitHub Actions)
Expand All @@ -6,7 +13,3 @@

## R CMD check results
There were no ERRORs, WARNINGs, or NOTEs.

## Additional notes
* This workflow was derived from the r-lib/actions examples (https://github.com/r-lib/actions/tree/v2/examples).
* All checks passed successfully across multiple operating systems and R versions.

0 comments on commit 3d62830

Please sign in to comment.