Skip to content

Commit

Permalink
Adding encoding UTF-8 to man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
adeschen committed Feb 22, 2024
1 parent de513f8 commit 95e9297
Show file tree
Hide file tree
Showing 30 changed files with 105 additions and 52 deletions.
5 changes: 3 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Description: This package compares genomic positions and genomic ranges from
peaks and nucleosome positions, the replication of an experiment may result
in slight differences between predicted values. This package enables the
conciliation of the results into consensus regions.
Authors@R: c(person("Astrid", "Deschenes", email="[email protected]",
Authors@R: c(person("Astrid", "Deschênes", email="[email protected]",
role=c("cre","aut"), comment=c(ORCID="0000-0001-7846-6749")),
person("Fabien Claude", "Lamaze", email="[email protected]",
role=c("ctb")),
Expand All @@ -39,10 +39,11 @@ Suggests:
rmarkdown,
RUnit
License: Artistic-2.0
Encoding: UTF-8
URL: https://github.com/adeschen/consensusSeekeR
BugReports: https://github.com/adeschen/consensusSeekeR/issues
VignetteBuilder: knitr
NeedsCompilation: no
biocViews: BiologicalQuestion, ChIPSeq, Genetics, MultipleComparison,
Transcription, PeakDetection, Sequencing, Coverage
RoxygenNote: 7.0.2
RoxygenNote: 7.2.3
3 changes: 2 additions & 1 deletion R/consensusSeekeR.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
#' Arnaud Droit
#'
#' Maintainer:
#' Astrid Deschenes <adeschen@@hotmail.com>
#' Astrid Deschênes <[email protected]>
#'
#' @seealso
#' \itemize{
Expand All @@ -28,6 +28,7 @@
#' sharing the same features in more than one experiment. }
#' }
#'
#' @encoding UTF-8
#' @keywords package
NULL

Expand Down
3 changes: 2 additions & 1 deletion R/findConsensusPeakRegions.R
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@
#' consensus regions.
#' }
#'
#' @author Astrid Deschenes
#' @import BiocGenerics IRanges GenomeInfoDb GenomicRanges
#' @importFrom stringr str_split
#' @importFrom BiocParallel bplapply SnowParam SerialParam
Expand Down Expand Up @@ -128,6 +127,8 @@
#' head(results$consensusRanges, 2)
#'
#' @importFrom GenomicRanges split
#' @author Astrid Deschênes
#' @encoding UTF-8
#' @export
findConsensusPeakRegions <- function(narrowPeaks, peaks, chrInfo,
extendingSize = 250,
Expand Down
16 changes: 10 additions & 6 deletions R/findConsensusPeakRegionsIntern.R
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,10 @@
#' minNbrExp = 2,
#' nbrThreads = 1)
#'
#' @author Astrid Deschenes
#' @author Astrid Deschênes
#' @import GenomeInfoDb
#' @importFrom methods is
#' @encoding UTF-8
#' @keywords internal
findConsensusPeakRegionsValidation <- function(narrowPeaks, peaks, chrList,
extendingSize, expandToFitPeakRegion, shrinkToFitPeakRegion,
Expand Down Expand Up @@ -157,10 +158,10 @@ findConsensusPeakRegionsValidation <- function(narrowPeaks, peaks, chrList,
}

if (minNbrExp > length(unique(names(peaks)))) {
stop(paste0("minNbrExp must be inferior or equal to the number ",
stop("minNbrExp must be inferior or equal to the number ",
"of experiments presents in peaks. The number of",
"experiments is known by the number of differents ",
"row names in peaks."))
"row names in peaks.")
}

if (!isInteger(nbrThreads) || nbrThreads < 1 ) {
Expand All @@ -183,7 +184,8 @@ findConsensusPeakRegionsValidation <- function(narrowPeaks, peaks, chrList,
#'
#' @return \code{TRUE} is the parameter is a integer; otherwise \code{FALSE}
#'
#' @author Astrid Deschenes
#' @author Astrid Deschênes
#' @encoding UTF-8
#' @keywords internal
isInteger <- function(value) {
result <- length(value) == 1
Expand Down Expand Up @@ -244,9 +246,10 @@ isInteger <- function(value) {
#'
#' @return an object of \code{class} "commonFeatures".
#'
#' @author Astrid Deschenes
#' @author Astrid Deschênes
#' @import BiocGenerics IRanges GenomeInfoDb GenomicRanges
#' @importFrom stringr str_split
#' @encoding UTF-8
#' @keywords internal
findConsensusPeakRegionsForOneChrom <- function(chrName, allPeaks,
allNarrowPeaks, extendingSize,
Expand Down Expand Up @@ -448,8 +451,9 @@ findConsensusPeakRegionsForOneChrom <- function(chrName, allPeaks,
#'
#' @return an object of \code{class} "commonFeatures".
#'
#' @author Astrid Deschenes
#' @author Astrid Deschênes
#' @import BiocGenerics IRanges GenomicRanges
#' @encoding UTF-8
#' @keywords internal
refineRegion <- function(peaks, setPeaks, extendingSize,
region_width, currentPeak) {
Expand Down
4 changes: 3 additions & 1 deletion man/A549_CTCF_MYJ_NarrowPeaks_partial.Rd

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

4 changes: 3 additions & 1 deletion man/A549_CTCF_MYJ_Peaks_partial.Rd

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

4 changes: 3 additions & 1 deletion man/A549_CTCF_MYN_NarrowPeaks_partial.Rd

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

4 changes: 3 additions & 1 deletion man/A549_CTCF_MYN_Peaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/A549_FOSL2_01_NarrowPeaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/A549_FOSL2_01_Peaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/A549_FOXA1_01_NarrowPeaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/A549_FOXA1_01_Peaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/A549_NR3C1_CFQ_NarrowPeaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/A549_NR3C1_CFQ_Peaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/A549_NR3C1_CFR_NarrowPeaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/A549_NR3C1_CFR_Peaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/A549_NR3C1_CFS_NarrowPeaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/A549_NR3C1_CFS_Peaks_partial.Rd

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

6 changes: 4 additions & 2 deletions man/NOrMAL_nucleosome_positions.Rd

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

6 changes: 4 additions & 2 deletions man/NOrMAL_nucleosome_ranges.Rd

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

6 changes: 4 additions & 2 deletions man/NucPosSimulator_nucleosome_positions.Rd

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

6 changes: 4 additions & 2 deletions man/NucPosSimulator_nucleosome_ranges.Rd

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

6 changes: 4 additions & 2 deletions man/PING_nucleosome_positions.Rd

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

6 changes: 4 additions & 2 deletions man/PING_nucleosome_ranges.Rd

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

3 changes: 2 additions & 1 deletion man/consensusSeekeR-package.Rd

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

Loading

0 comments on commit 95e9297

Please sign in to comment.