Skip to content

Commit

Permalink
Use Roxygen to transfer package DESCRIPTION to documentation.
Browse files Browse the repository at this point in the history
Also take this opportunity to revamp package description.
  • Loading branch information
Charles Plessy committed May 9, 2024
1 parent 80f69db commit 93d2fb1
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 37 deletions.
16 changes: 13 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,18 @@ Suggests:
BiocStyle,
knitr,
rmarkdown
Description: Preprocessing of CAGE sequencing data, identification and
normalization of transcription start sites and downstream analysis of
transcription start sites clusters (promoters).
Description: The _CAGEr_ package identifies transcription start sites (TSS) and
their usage frequency from CAGE (Cap Analysis Gene Expression) sequencing data.
It normalises raw CAGE tag count, clusters TSSs into tag clusters (TC) and
aggregates them across multiple CAGE experiments to construct consensus
clusters (CC) representing the promoterome. CAGEr provides functions to
profile expression levels of these clusters by cumulative expression and
rarefaction analysis, and outputs the plots in ggplot2 format for further
facetting and customisation. After clustering, CAGEr performs analyses of
promoter width and detects differential usage of TSSs (promoter shifting)
between samples. CAGEr also exports its data as genome browser tracks, and as
R objects for downsteam expression analysis by other Bioconductor packages
such as DESeq2, CAGEfightR, or seqArchR.
License: GPL-3
biocViews: Preprocessing, Sequencing, Normalization, FunctionalGenomics, Transcription, GeneExpression, Clustering, Visualization
Collate:
Expand All @@ -63,6 +72,7 @@ Collate:
'Annotations.R'
'AggregationMethods.R'
'CAGEfightR.R'
'CAGEr-package.R'
'CorrelationMethods.R'
'CumulativeDistributionFunctions.R'
'GetMethods.R'
Expand Down
20 changes: 0 additions & 20 deletions R/CAGEr.R
Original file line number Diff line number Diff line change
@@ -1,25 +1,5 @@
#' @include CAGEexp.R CTSS.R
NULL

#' Analysis of CAGE (Cap Analysis of Gene Expression) sequencing data for
#' precise mapping of transcription start sites and promoterome mining
#'
#' The _CAGEr_ package performs identification of transcription start sites and
#' frequency of their usage from input CAGE sequencing data, normalization of
#' raw CAGE tag count, clustering of TSSs into tag clusters (TC) and their
#' aggregation across multiple CAGE experiments to construct the promoterome.
#' It manipulates multiple CAGE experiments at once, performs expression
#' profiling across experiments both at level of individual TSSs and clusters of
#' TSSs, exports several different types of track files for visualization in the
#' UCSC Genome Browser, performs analysis of promoter width and detects
#' differential usage of TSSs (promoter shifting) between samples. Multicore
#' option for parallel processing is supported on Unix-like platforms.
#'
#' @author Vanja Haberle
#'
#' @docType package
#' @name CAGEr-package
NULL

#' CAGEr objects
#'
Expand Down
31 changes: 17 additions & 14 deletions man/CAGEr-package.Rd

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

0 comments on commit 93d2fb1

Please sign in to comment.