diff --git a/.Rbuildignore b/.Rbuildignore index f48efd1..69270ae 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -4,3 +4,6 @@ ^scripts$ ^doc$ ^Meta$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..ed7650c --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,48 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + release: + types: [published] + workflow_dispatch: + +name: pkgdown + +jobs: + pkgdown: + runs-on: ubuntu-latest + # Only restrict concurrency for non-PR jobs + concurrency: + group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + permissions: + contents: write + steps: + - uses: actions/checkout@v3 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::pkgdown, local::. + needs: website + + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) + shell: Rscript {0} + + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.4.1 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/DESCRIPTION b/DESCRIPTION index fb778ef..7fcf38a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -36,4 +36,5 @@ Suggests: VignetteBuilder: knitr Roxygen: list(markdown = TRUE) -RoxygenNote: 7.1.2 +RoxygenNote: 7.2.3 +URL: https://nbisweden.github.io/genecovr/ diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..cbab03d --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://nbisweden.github.io/genecovr/ +template: + bootstrap: 5 + diff --git a/man/geneBodyCoverage.Rd b/man/geneBodyCoverage.Rd index 063aa6d..0d39d41 100644 --- a/man/geneBodyCoverage.Rd +++ b/man/geneBodyCoverage.Rd @@ -37,13 +37,15 @@ breadthOfCoverage indicates the multiplicity of the query. For queries that map multiple subjects, a value close to 1 indicates the query has been split in several subjects, whereas a higher value indicates sequence duplication at the -subject level.\preformatted{The revmap column maps the output ranges to the input ranges +subject level. + +\if{html}{\out{
}}\preformatted{The revmap column maps the output ranges to the input ranges as lists of numerical ids. These ids can be used to retrieve the corresponding AlignmentPairs ranges providing a link to the subjects. The hitCoverage lists the width of each reduced hit, and hitStart and hitEnd provide the transcript coordinates of these hits. -} +}\if{html}{\out{
}} } \description{ \code{geneBodyCoverage(obj, ...)}: calculate gene body coverage from input @@ -60,7 +62,9 @@ being that if there are >1 overlaps for a seqname, the sequence is associated with multiple distinct regions in the subject sequence. Thus, the unit of interest here is the query, and the function seeks to identify reduced disjoint -regions of a query sequence that map to a subject.\preformatted{The function returns a GRanges object with reduced regions, +regions of a query sequence that map to a subject. + +\if{html}{\out{
}}\preformatted{The function returns a GRanges object with reduced regions, i.e. overlaps are merged. Information about matches and mismatches is currently dropped as it usually is not possible to infer where mismatches occur. Instead, the data column @@ -74,5 +78,5 @@ matches to the width of the region. Since the association between query and subject regions is removed, the return value is a GRanges object consisting of the reduced query ranges with a revmap and coverage attribute. -} +}\if{html}{\out{
}} } diff --git a/man/genecovr-package.Rd b/man/genecovr-package.Rd index 89c0c0c..d87372b 100644 --- a/man/genecovr-package.Rd +++ b/man/genecovr-package.Rd @@ -19,6 +19,13 @@ measurement unit is a gene or transcript model. autoplot: plot GRanges objects with gene body coverage metrics } +\seealso{ +Useful links: +\itemize{ + \item \url{https://nbisweden.github.io/genecovr/} +} + +} \author{ \strong{Maintainer}: Per Unneberg \email{per.unneberg@nbis.se} (\href{https://orcid.org/0000-0001-5735-3315}{ORCID}) diff --git a/man/reduceHitCoverage.Rd b/man/reduceHitCoverage.Rd index 1636aa1..d4f693b 100644 --- a/man/reduceHitCoverage.Rd +++ b/man/reduceHitCoverage.Rd @@ -27,7 +27,9 @@ being that if there are >1 overlaps for a seqname, the sequence is associated with multiple distinct regions in the subject sequence. Thus, the unit of interest here is the query, and the function seeks to identify reduced disjoint -regions of a query sequence that map to a subject.\preformatted{The function returns a GRanges object with reduced regions, +regions of a query sequence that map to a subject. + +\if{html}{\out{
}}\preformatted{The function returns a GRanges object with reduced regions, i.e. overlaps are merged. Information about matches and mismatches is currently dropped as it usually is not possible to infer where mismatches occur. Instead, the data column @@ -41,7 +43,7 @@ matches to the width of the region. Since the association between query and subject regions is removed, the return value is a GRanges object consisting of the reduced query ranges with a revmap and coverage attribute. -} +}\if{html}{\out{
}} } \examples{ ranges <- IRanges::IRanges(