Skip to content

Commit

Permalink
fix: formatting issues
Browse files Browse the repository at this point in the history
  • Loading branch information
m-jahn committed Jan 21, 2025
1 parent 8465fd8 commit 7a30054
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 50 deletions.
16 changes: 8 additions & 8 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,13 @@ Authors@R: c(
comment = c(ORCID = "0000-0002-3913-153X"))
)
Maintainer: Yabing Song <[email protected]>
Description: The goal of 'ggcoverage' is to visualize coverage tracks from
genomics, transcriptomics or proteomics data. It contains functions to
load data from BAM, BigWig, BedGraph, txt, or xlsx files, create
genome/protein coverage plots, and add various annotations including
base and amino acid composition, GC content, copy number variation
(CNV), genes, transcripts, ideograms, peak highlights, HiC contact
maps, contact links and protein features. It is based on and
integrates well with 'ggplot2'.
Description: Visualize coverage tracks from genomics, transcriptomics
or proteomics data. The package contains functions to load data from 'BAM',
'BigWig', 'BedGraph', 'txt', or 'xlsx' files, create genome/protein coverage
plots, and add various annotations including base and amino acid
composition, GC content, copy number variation (CNV), genes, transcripts,
ideograms, peak highlights, HiC contact maps, contact links and protein
features. It is based on and integrates well with 'ggplot2'.
License: MIT + file LICENSE
URL: https://showteeth.github.io/ggcoverage/,
https://github.com/showteeth/ggcoverage
Expand Down Expand Up @@ -51,6 +50,7 @@ Suggests:
HiCBricks,
htmltools,
knitr,
openxlsx,
rmarkdown
VignetteBuilder:
knitr
Expand Down
9 changes: 0 additions & 9 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -446,10 +446,8 @@ THe default color scheme for base annotation is `Clustal-style`, more popular co
nuc_color <- c(
"A" = "#ff2b08", "C" = "#009aff", "G" = "#ffb507", "T" = "#00bc0d"
)
opar <- graphics::par()
# create plot
graphics::par(mar = c(1, 5, 1, 1))
graphics::image(
seq_along(nuc_color),
1,
Expand All @@ -468,9 +466,6 @@ graphics::mtext(
las = 1,
side = 2
)
# reset par default
graphics::par(opar)
```

Default color scheme for amino acid annotation is from [Residual colours: a proposal for aminochromography](https://pubmed.ncbi.nlm.nih.gov/9342138/):
Expand All @@ -486,7 +481,6 @@ aa_color <- c(
" " = "#FFFFFF"
)
graphics::par(mar = c(1, 5, 1, 1))
graphics::image(
1:5,
1:5,
Expand All @@ -506,9 +500,6 @@ graphics::mtext(
las = 1,
side = 2
)
# reset par default
graphics::par(opar)
```

#### Add base and amino acid annotation
Expand Down
15 changes: 0 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -626,10 +626,8 @@ popular color schemes are available
nuc_color <- c(
"A" = "#ff2b08", "C" = "#009aff", "G" = "#ffb507", "T" = "#00bc0d"
)
opar <- graphics::par()

# create plot
graphics::par(mar = c(1, 5, 1, 1))
graphics::image(
seq_along(nuc_color),
1,
Expand All @@ -652,12 +650,6 @@ graphics::mtext(

<img src="man/figures/README-base_color_scheme-1.png" width="100%" style="display: block; margin: auto;" />

``` r

# reset par default
graphics::par(opar)
```

Default color scheme for amino acid annotation is from [Residual
colours: a proposal for
aminochromography](https://pubmed.ncbi.nlm.nih.gov/9342138/):
Expand All @@ -673,7 +665,6 @@ aa_color <- c(
" " = "#FFFFFF"
)

graphics::par(mar = c(1, 5, 1, 1))
graphics::image(
1:5,
1:5,
Expand All @@ -697,12 +688,6 @@ graphics::mtext(

<img src="man/figures/README-aa_color_scheme-1.png" width="100%" style="display: block; margin: auto;" />

``` r

# reset par default
graphics::par(opar)
```

#### Add base and amino acid annotation

**Use twill to mark position with SNV**:
Expand Down
24 changes: 15 additions & 9 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Resubmission

Update for current submission:
This package has been submitted previously (2023, v0.7.1) and was removed
from CRAN due to several issues, which have been addressed now.

## Issues

### Update for current submission:

- fixed DESCRIPTION abstract, added quotation marks for package names etc
- examples that are running >5 sec were wrapped in `/donttest{}` instead of `/dontrun{}`
- example in `ggcoverage.Rd` does not contain out-commented code as stated by the reviewer
- changing of graphical parameters using `par(mfrow=c(2,2))` were removed from vignette
- however the package does not contain any `par()` statement in any of the
functions (supposedly `R/geom_base.R`) as stated by the reviewer

### Previously fixed issues

- We have substantially removed the size of test files for the examples,
reducing overall package size from ~30 Mb to only ~6 Mb. A further reduction
Expand All @@ -13,14 +27,6 @@ on the test environment -- this package never exceeds the threshold when
tested locally on a 3 year old average laptop, or in 3 different github actions
workflows, but regularly fails on the CRAN server.

Background information:

This package has been submitted previously (2023, v0.7.1) and was removed from
CRAN due to several issues. In the mean time many functions were re-factored,
more than 10 dependencies were removed to make the package lighter, and other
problems regarding documentation and style were fixed. Current version 1.4.0
now builds fine on the tested platforms.

## Test environments

### Local
Expand Down
9 changes: 0 additions & 9 deletions vignettes/ggcoverage.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -475,10 +475,8 @@ THe default color scheme for base annotation is `Clustal-style`, more popular co
nuc_color <- c(
"A" = "#ff2b08", "C" = "#009aff", "G" = "#ffb507", "T" = "#00bc0d"
)
opar <- graphics::par()
# create plot
graphics::par(mar = c(1, 5, 1, 1))
graphics::image(
seq_along(nuc_color),
1,
Expand All @@ -497,9 +495,6 @@ graphics::mtext(
las = 1,
side = 2
)
# reset par default
graphics::par(opar)
```

Default color scheme for amino acid annotation is from [Residual colours: a proposal for aminochromography](https://pubmed.ncbi.nlm.nih.gov/9342138/):
Expand All @@ -515,7 +510,6 @@ aa_color <- c(
" " = "#FFFFFF"
)
graphics::par(mar = c(1, 5, 1, 1))
graphics::image(
1:5,
1:5,
Expand All @@ -535,9 +529,6 @@ graphics::mtext(
las = 1,
side = 2
)
# reset par default
graphics::par(opar)
```

#### Add base and amino acid annotation
Expand Down

0 comments on commit 7a30054

Please sign in to comment.