Skip to content

Commit e01f0e7

Browse files
committed
bioc-check lint; refresh readme
1 parent 0fcd627 commit e01f0e7

File tree

3 files changed

+50
-58
lines changed

3 files changed

+50
-58
lines changed

DESCRIPTION

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ Authors@R:
1616
email = "[email protected]",
1717
comment = c(ORCID = "0000-0002-4108-4218"))
1818
License: GPL-3
19+
URL: https://github.com/mfansler/txcutr
20+
BugReports: https://github.com/mfansler/txcutr/issues
1921
Encoding: UTF-8
2022
Depends:
21-
R (>= 4.1.0)
23+
R (>= 4.5.0)
2224
Imports:
2325
AnnotationDbi,
2426
GenomicFeatures,

README.Rmd

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ knitr::opts_chunk$set(
1818
<!-- badges: start -->
1919
[![R build status](https://github.com/mfansler/txcutr/workflows/R-CMD-check-bioc/badge.svg)](https://github.com/mfansler/txcutr/actions)
2020
[![codecov](https://codecov.io/gh/mfansler/txcutr/branch/bioc-check/graph/badge.svg?token=CGGZP68G67)](https://codecov.io/gh/mfansler/txcutr)
21-
[![Anaconda-Server Badge](https://anaconda.org/merv/r-txcutr/badges/installer/conda.svg)](https://conda.anaconda.org/merv/r-txcutr)
22-
[![Anaconda-Server Badge](https://anaconda.org/merv/r-txcutr/badges/version.svg)](https://anaconda.org/merv/r-txcutr)
21+
[![Anaconda-Server Badge](https://anaconda.org/bioconda/bioconductor-txcutr/badges/version.svg)](https://anaconda.org/bioconda/bioconductor-txcutr)
2322
<!-- badges: end -->
2423

2524
## Overview
@@ -43,24 +42,22 @@ if (!requireNamespace("BiocManager", quietly = TRUE)) {
4342
BiocManager::install("txcutr")
4443
```
4544

46-
And the development version from [GitHub](https://github.com/mfansler/txcutr) with:
45+
or the development version with:
4746

4847
```{r 'install_dev', eval = FALSE}
49-
BiocManager::install("mfansler/txcutr")
48+
# The following initializes usage of Bioc devel
49+
BiocManager::install(version='devel')
50+
51+
BiocManager::install("txcutr")
5052
```
5153

52-
### Conda/Mamba
54+
### Conda
5355

54-
Users managing R environments with Conda/Mamba can install the package with:
56+
Users managing R environments with Conda can install the package with:
5557

5658
**Conda**
5759
```bash
58-
conda install -c conda-forge -c bioconda merv::r-txcutr
59-
```
60-
61-
**Mamba**
62-
```bash
63-
mamba install -c conda-forge -c bioconda merv::r-txcutr
60+
conda install -c conda-forge -c bioconda bioconductor-txcutr
6461
```
6562

6663
We strongly encourage users to create dedicated R environments. **Do not

README.md

Lines changed: 38 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@
99
status](https://github.com/mfansler/txcutr/workflows/R-CMD-check-bioc/badge.svg)](https://github.com/mfansler/txcutr/actions)
1010
[![codecov](https://codecov.io/gh/mfansler/txcutr/branch/bioc-check/graph/badge.svg?token=CGGZP68G67)](https://codecov.io/gh/mfansler/txcutr)
1111
[![Anaconda-Server
12-
Badge](https://anaconda.org/merv/r-txcutr/badges/installer/conda.svg)](https://conda.anaconda.org/merv/r-txcutr)
13-
[![Anaconda-Server
14-
Badge](https://anaconda.org/merv/r-txcutr/badges/version.svg)](https://anaconda.org/merv/r-txcutr)
12+
Badge](https://anaconda.org/bioconda/bioconductor-txcutr/badges/version.svg)](https://anaconda.org/bioconda/bioconductor-txcutr)
1513
<!-- badges: end -->
1614

1715
## Overview
@@ -39,28 +37,23 @@ if (!requireNamespace("BiocManager", quietly = TRUE)) {
3937
BiocManager::install("txcutr")
4038
```
4139

42-
And the development version from
43-
[GitHub](https://github.com/mfansler/txcutr) with:
40+
or the development version with:
4441

4542
``` r
46-
BiocManager::install("mfansler/txcutr")
43+
# The following initializes usage of Bioc devel
44+
BiocManager::install(version='devel')
45+
46+
BiocManager::install("txcutr")
4747
```
4848

49-
### Conda/Mamba
49+
### Conda
5050

51-
Users managing R environments with Conda/Mamba can install the package
52-
with:
51+
Users managing R environments with Conda can install the package with:
5352

5453
**Conda**
5554

5655
``` bash
57-
conda install -c conda-forge -c bioconda merv::r-txcutr
58-
```
59-
60-
**Mamba**
61-
62-
``` bash
63-
mamba install -c conda-forge -c bioconda merv::r-txcutr
56+
conda install -c conda-forge -c bioconda bioconductor-txcutr
6457
```
6558

6659
We strongly encourage users to create dedicated R environments. **Do not
@@ -70,10 +63,10 @@ install this in your *base* environment!**
7063

7164
A typical workflow for `txcutr` involves
7265

73-
- loading an existing annotation as `TxDb` object
74-
- truncating the annotation
75-
- exporting the truncated annotation (GTF)
76-
- exporting supporting files (FASTA, merge TSV)
66+
- loading an existing annotation as `TxDb` object
67+
- truncating the annotation
68+
- exporting the truncated annotation (GTF)
69+
- exporting supporting files (FASTA, merge TSV)
7770

7871
``` r
7972
library(rtracklayer)
@@ -108,19 +101,19 @@ Please run this yourself to check for any updates on how to cite
108101

109102
``` r
110103
print(citation('txcutr'), bibtex = TRUE)
111-
#>
112104
#> To cite package 'txcutr' in publications use:
113105
#>
114-
#> Mervin Fansler (2021). txcutr: Transcriptome CUTteR. R package
115-
#> version 0.99.1.
106+
#> Fansler M (2025). _txcutr: Transcriptome CUTteR_. R package version
107+
#> 1.15.2, <https://github.com/mfansler/txcutr>.
116108
#>
117109
#> A BibTeX entry for LaTeX users is
118110
#>
119111
#> @Manual{,
120112
#> title = {txcutr: Transcriptome CUTteR},
121113
#> author = {Mervin Fansler},
122-
#> year = {2021},
123-
#> note = {R package version 0.99.1},
114+
#> year = {2025},
115+
#> note = {R package version 1.15.2},
116+
#> url = {https://github.com/mfansler/txcutr},
124117
#> }
125118
```
126119

@@ -136,27 +129,27 @@ contributing to this project, you agree to abide by its terms.
136129

137130
## Development tools
138131

139-
- Continuous code testing is possible thanks to [GitHub
140-
actions](https://www.tidyverse.org/blog/2020/04/usethis-1-6-0/)
141-
through *[usethis](https://CRAN.R-project.org/package=usethis)*,
142-
*[remotes](https://CRAN.R-project.org/package=remotes)*, and
143-
*[rcmdcheck](https://CRAN.R-project.org/package=rcmdcheck)*
144-
customized to use [Bioconductor’s docker
145-
containers](https://www.bioconductor.org/help/docker/) and
146-
*[BiocCheck](https://bioconductor.org/packages/3.13/BiocCheck)*.
147-
- Code coverage assessment is possible thanks to
148-
[codecov](https://codecov.io/gh) and
149-
*[covr](https://CRAN.R-project.org/package=covr)*.
150-
- The [documentation website](http://mfansler.github.io/txcutr) is
151-
automatically updated thanks to
152-
*[pkgdown](https://CRAN.R-project.org/package=pkgdown)*.
153-
- The code is styled automatically thanks to
154-
*[styler](https://CRAN.R-project.org/package=styler)*.
155-
- The documentation is formatted thanks to
156-
*[devtools](https://CRAN.R-project.org/package=devtools)* and
157-
*[roxygen2](https://CRAN.R-project.org/package=roxygen2)*.
132+
- Continuous code testing is possible thanks to [GitHub
133+
actions](https://www.tidyverse.org/blog/2020/04/usethis-1-6-0/)
134+
through *[usethis](https://CRAN.R-project.org/package=usethis)*,
135+
*[remotes](https://CRAN.R-project.org/package=remotes)*, and
136+
*[rcmdcheck](https://CRAN.R-project.org/package=rcmdcheck)* customized
137+
to use [Bioconductor’s docker
138+
containers](https://www.bioconductor.org/help/docker/) and
139+
*[BiocCheck](https://bioconductor.org/packages/3.20/BiocCheck)*.
140+
- Code coverage assessment is possible thanks to
141+
[codecov](https://codecov.io/gh) and
142+
*[covr](https://CRAN.R-project.org/package=covr)*.
143+
- The [documentation website](http://mfansler.github.io/txcutr) is
144+
automatically updated thanks to
145+
*[pkgdown](https://CRAN.R-project.org/package=pkgdown)*.
146+
- The code is styled automatically thanks to
147+
*[styler](https://CRAN.R-project.org/package=styler)*.
148+
- The documentation is formatted thanks to
149+
*[devtools](https://CRAN.R-project.org/package=devtools)* and
150+
*[roxygen2](https://CRAN.R-project.org/package=roxygen2)*.
158151

159152
For more details, check the `dev` directory.
160153

161154
This package was developed using
162-
*[biocthis](https://bioconductor.org/packages/3.13/biocthis)*.
155+
*[biocthis](https://bioconductor.org/packages/3.20/biocthis)*.

0 commit comments

Comments
 (0)