Skip to content

Commit

Permalink
more updates for pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
mikelove committed Aug 26, 2023
1 parent 802e612 commit be6c80d
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 32 deletions.
14 changes: 1 addition & 13 deletions .github/workflows/check-bioc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,6 @@ jobs:
mkdir /__w/_temp/Library
echo ".libPaths('/__w/_temp/Library')" > ~/.Rprofile
- name: work around permission issue
run: git config --global --add safe.directory /__w/nullranges/nullranges

## Most of these steps are the same as the ones in
## https://github.com/r-lib/actions/blob/master/examples/check-standard.yaml
## If they update their steps, we will also need to update ours.
Expand Down Expand Up @@ -185,15 +182,6 @@ jobs:
# BiocManager::install("BiocCheck")
shell: Rscript {0}

- name: Try downloading data
run: |
## Attempt to download the data needed for vignette
library(nullrangesData)
dhs <- DHSA549Hg38()
bins <- hg19_10kb_bins()
binPairs <- hg19_10kb_ctcfBoundBinPairs()
shell: Rscript {0}

- name: Install BiocGenerics
if: env.has_RUnit == 'true'
run: |
Expand Down Expand Up @@ -287,7 +275,7 @@ jobs:
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: nullranges/nullranges
repository: thelovelab/tximeta
tag_with_ref: true
tag_with_sha: true
tags: latest
11 changes: 5 additions & 6 deletions R/tximeta.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' Import transcript-level quantification data with automatic metadata
#' Import transcript quantification with metadata
#'
#' The tximeta package imports abundances (TPM), estimated counts,
#' and effective lengths from Salmon, alevin, or other quantification
Expand All @@ -14,10 +14,9 @@
#' The main functions are:
#' \itemize{
#' \item \code{\link{tximeta}} - with key argument: \code{coldata}
#' \item \code{\link{summarizeToGene}} - summarize quants to gene-level
#' \item \code{\link{summarizeToGene,SummarizedExperiment-method}} - summarize quants to gene-level
#' \item \code{\link{retrieveDb}} - retrieve the transcript database
#' \item \code{\link{addIds}} - add transcript or gene ID (see \code{gene} argument)
#' \item \code{\link{addExons}} - convert from GRanges to GRangesList
#' }
#'
#' All software-related questions should be posted to the Bioconductor Support Site:
Expand All @@ -27,7 +26,7 @@
#' The code can be viewed at the GitHub repository,
#' which also lists the contributor code of conduct:
#'
#' \url{https://github.com/mikelove/tximeta}
#' \url{https://github.com/thelovelab/tximeta}
#'
#' @references
#'
Expand All @@ -54,8 +53,8 @@
#' @keywords package
NULL

#' tximeta: Transcript quantification import with automatic metadata
#'
#' Import transcript quantification with metadata
#'
#' \code{tximeta} leverages the hashed checksum of the Salmon index,
#' in addition to a number of core Bioconductor packages (GenomicFeatures,
#' ensembldb, AnnotationHub, GenomeInfoDb, BiocFileCache) to automatically
Expand Down
7 changes: 3 additions & 4 deletions man/tximeta-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/tximeta.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ reference:
contents:
- tximeta
- starts_with("summarizeToGene")
- title: "Add info"
- title: "Add information to SE"
contents:
- starts_with("add")
- title: "linked"
contents:
- contains("linkedTxome")
- title: "Retrieve info"
- title: "Retrieve information from SE"
contents:
- starts_with("retrieve")
- title: "linkedTxome for custom transcriptomes"
contents:
- contains("linkedTxome")
- title: "Other helpers"
contents:
- splitSE
Expand Down
6 changes: 3 additions & 3 deletions vignettes/tximeta.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ or to bundle one alevin output directory. For tips on using `tximeta`
with other quantifiers see the
[other quantifiers](#other_quantifiers) section below.

<center>
<img width=600 src="diagram.png"/>
</center>
```{r echo=FALSE}
knitr::include_graphics("images/diagram.png")
```

# Tximeta import starts with sample table

Expand Down

0 comments on commit be6c80d

Please sign in to comment.