forked from GreenleafLab/ArchR
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcreateGenomeAnnotation.Rd
30 lines (26 loc) · 1.22 KB
/
createGenomeAnnotation.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/AnnotationGenome.R
\name{createGenomeAnnotation}
\alias{createGenomeAnnotation}
\title{Create a genome annotation object for ArchR}
\usage{
createGenomeAnnotation(
genome = NULL,
chromSizes = NULL,
blacklist = NULL,
filter = TRUE,
filterChr = c("chrM")
)
}
\arguments{
\item{genome}{Either (i) a string that is a valid \code{BSgenome} or (ii) a \code{BSgenome} object (ie "hg38" or "BSgenome.Hsapiens.UCSC.hg38").}
\item{chromSizes}{A \code{GRanges} object containing chromosome start and end coordinates.}
\item{blacklist}{A \code{GRanges} object containing regions that should be excluded from analyses due to unwanted biases.}
\item{filter}{A boolean value indicating whether non-standard chromosome scaffolds should be excluded.
These "non-standard" chromosomes are defined by \code{filterChrGR()}.}
\item{filterChr}{A character vector indicating the seqlevels that should be removed if manual removal is desired for certain seqlevels.
If no manual removal is desired, \code{filterChr} should be set to \code{NULL}.}
}
\description{
This function will create a genome annotation object that can be used for creating ArrowFiles or an ArchRProject, etc.
}