<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" dir="ltr" lang="en-US"
prefix="og: http://ogp.me/ns#">
  <head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Content-Language" content="en-us" />
  <meta name="robots" content="all" />
  

  <meta property="og:title" content="BUSpaRse" />
  <meta property="og:type" content="website" />
  <meta property="og:site_name" content="Bioconductor" />
  <meta property="og:description" content="The kallisto | bustools pipeline is a fast and modular set of tools to convert single cell RNA-seq reads in fastq files into gene count or transcript compatibility counts (TCC) matrices for downstream analysis. Central to this pipeline is the barcode, UMI, and set (BUS) file format. This package serves the following purposes: First, this package allows users to manipulate BUS format files as data frames in R and then convert them into gene count or TCC matrices. Furthermore, since R and Rcpp code is easier to handle than pure C++ code, users are encouraged to tweak the source code of this package to experiment with new uses of BUS format and different ways to convert the BUS file into gene count matrix. Second, this package can conveniently generate files required to generate gene count matrices for spliced and unspliced transcripts for RNA velocity. Here biotypes can be filtered and scaffolds and haplotypes can be removed, and the filtered transcriptome can be extracted and written to disk. Third, this package implements utility functions to get transcripts and associated genes required to convert BUS files to gene count matrices, to write the transcript to gene information in the format required by bustools, and to read output of bustools into R as sparses matrices." />
  <meta property="og:url" content="http://bioconductor.org/packages/BUSpaRse/" />
  <meta property="og:image" content="http://bioconductor.org/images/logo/jpg/bioconductor_logo_rgb.jpg" />



  
  
  
    <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.min.js"></script>
    <script type="text/javascript">
        if (!window.location.href.match(/bioconductor\.org|\/\/localhost/i)) {
            var mirror = true;
            document.write('<base href="//www.bioconductor.org"/>\n');
        } 
    </script>
  
  
  <script src="/js/jquery.tools.min.js"></script>

  
  
  <title>Bioconductor - BUSpaRse</title>
  <link rel="stylesheet" type="text/css" href="/style/bioconductor.css" media="screen" />
  <link rel="SHORTCUT ICON" type="image/x-icon" href="/favicon.ico" />
  <link rel="ICON" type="image/x-icon" href="/favicon.ico" />
  <script type="text/javascript" src="/js/bioconductor.js"></script>
 
  <script type="text/javascript" src="/js/jquery.corner.js"></script>
  <script type="text/javascript" src="/js/jquery.timeago.js"></script>
  <script type="text/javascript" src="/js/bioc-style.js"></script>
  <script type="text/javascript" src="/js/versions.js"></script>

  <!-- Google Analytics script -->
  <script type="text/javascript">
    var _gaq = _gaq || [];
    _gaq.push(['_setAccount', 'UA-9338486-1']);
    _gaq.push(['_trackPageview']);

    (function() {
      var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
      ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
      var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
    })();
  </script>
</head>

  <body>
    <a name="top"></a>

<!-- a few hooks for screen readers -->
<a href="#site-navigation" title="Jump to site nav"></a>

<a href="#site-map" title="Jump to site map"></a>


    <div id="SiteContainer" class="SiteContainer">
      
      <div id="PageContent" class="PageContent WithRightRail">
      


	
	  <div id="PageBreadcrumbs" class="PageBreadcrumbs">
  <ul>
    
    
    
      
	  	
        <li><a href="/">Home</a></li>
      
    
    
      
	  	
        <li><a href="/packages/3.11/BiocViews.html">Bioconductor 3.11</a></li>
      
    
    
      
	  	
        <li><a href="/packages/3.11/bioc">Software Packages</a></li>
      
    
    
      
        <li>BUSpaRse</li>
      
    
  </ul>
</div>

	

	
	
	    <h1>BUSpaRse</h1>

  




<div class='do_not_rebase'>

	DOI: <a title="DOI for use in publications, etc., will always redirect to current release version (or devel if package is not in release yet)." href="https://doi.org/doi:10.18129/B9.bioc.BUSpaRse">10.18129/B9.bioc.BUSpaRse</a> &nbsp;

<a title="Share on Facebook" href="https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fbioconductor.org%2Fpackages%2F3.11%2Fbioc%2Fhtml%2FBUSpaRse.html"><img height="16" width="16" src="/images/facebook.png"/></a> &nbsp;
<a title="Share on Twitter" href="https://twitter.com/intent/tweet?url=https%3A%2F%2Fbioconductor.org%2Fpackages%2F3.11%2Fbioc%2Fhtml%2FBUSpaRse.html&text=BUSpaRse:kallisto%20%7C%20bustools%20R%20utilities"><img height="16" width="16" src="/images/twitter.png"/></a>

   

   <p>This package is for version 3.11 of Bioconductor;
for the stable, up-to-date release version, see
<a href="/packages/BUSpaRse/">BUSpaRse</a>.</p>


   

    <h2>kallisto | bustools R utilities</h2>

    <p>
	Bioconductor version: 3.11
    </p>

    <p>The kallisto | bustools pipeline is a fast and modular set of tools to convert single cell RNA-seq reads in fastq files into gene count or transcript compatibility counts (TCC) matrices for downstream analysis. Central to this pipeline is the barcode, UMI, and set (BUS) file format. This package serves the following purposes: First, this package allows users to manipulate BUS format files as data frames in R and then convert them into gene count or TCC matrices. Furthermore, since R and Rcpp code is easier to handle than pure C++ code, users are encouraged to tweak the source code of this package to experiment with new uses of BUS format and different ways to convert the BUS file into gene count matrix. Second, this package can conveniently generate files required to generate gene count matrices for spliced and unspliced transcripts for RNA velocity. Here biotypes can be filtered and scaffolds and haplotypes can be removed, and the filtered transcriptome can be extracted and written to disk. Third, this package implements utility functions to get transcripts and associated genes required to convert BUS files to gene count matrices, to write the transcript to gene information in the format required by bustools, and to read output of bustools into R as sparses matrices.</p>

    <p>Author: Lambda Moses [aut, cre] <a title='orcid' href='https://orcid.org/0000-0002-7092-9427'><img src='/images/orcid.png'/></a>, Lior Pachter [aut, ths] <a title='orcid' href='https://orcid.org/0000-0002-9164-6231'><img src='/images/orcid.png'/></a> </p>

    <p>Maintainer: Lambda Moses &#x3c;&#x64;&#x6c;&#x75;&#x32;&#x20;&#x61;&#x74;&#x20;&#x63;&#x61;&#x6c;&#x74;&#x65;&#x63;&#x68;&#x2e;&#x65;&#x64;&#x75;&#x3e; </p>


   <div id="bioc_citation_outer">
    <p>Citation (from within R,
      enter <code>citation("BUSpaRse")</code>):</p>
      <div id="bioc_citation" class="bioc_citation"></div>
    </div>

    <h3>Installation</h3>

    <p>To install this package, start R (version
    "4.0") and enter:
    </p>

    <pre>if (!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")

BiocManager::install("BUSpaRse")</pre>

    <p>For older versions of R, please refer to the appropriate
	<a href="/about/release-announcements/">Bioconductor release</a>.
    </p>

    <h3>Documentation</h3>


  
<p>To view documentation for the version of this package installed
    in your system, start R and enter:
</p>
<pre>browseVignettes("BUSpaRse")</pre>
    <p>&nbsp;</p>



    <table>
	
	
	
	    
		
		
		<tr class="row_odd">
		    <td class="docFixedWidth">
			
			<a href="../vignettes/BUSpaRse/inst/doc/sparse-matrix.html">HTML</a>
			
		    </td>
		    <td class="docFixedWidth">
			
			<a onClick="javascript: pageTracker._trackPageview('../vignettes/BUSpaRse/inst/doc/sparse-matrix.R'); " href="../vignettes/BUSpaRse/inst/doc/sparse-matrix.R">R Script</a>
			
		    </td>
		    <td>Converting BUS format into sparse matrix</td>
		</tr>

	    
		
		
		<tr class="row_even">
		    <td class="docFixedWidth">
			
			<a href="../vignettes/BUSpaRse/inst/doc/tr2g.html">HTML</a>
			
		    </td>
		    <td class="docFixedWidth">
			
			<a onClick="javascript: pageTracker._trackPageview('../vignettes/BUSpaRse/inst/doc/tr2g.R'); " href="../vignettes/BUSpaRse/inst/doc/tr2g.R">R Script</a>
			
		    </td>
		    <td>Transcript to gene</td>
		</tr>

	    
	


	    

	    
	    <tr class="row_odd">
		<td class="docFixedWidth">
		    <a onClick="javascript: pageTracker._trackPageview('../manuals/BUSpaRse/man/BUSpaRse.pdf'); " href="../manuals/BUSpaRse/man/BUSpaRse.pdf">PDF</a>
		</td>
		<td class="docFixedWidth">&nbsp;</td>
		<td>Reference Manual</td>
		
	    </tr>
	    

	    


	    
		
		<tr class="row_even">
		    <td class="docFixedWidth">
			<a href="../news/BUSpaRse/NEWS">Text</a>
		    </td>
		    <td class="docFixedWidth">&nbsp;</td>
		    <td>NEWS</td>
		</tr>
		
	    


	    


	    
		
		<tr class="row_odd">
		    <td class="docFixedWidth">
			<a href="../licenses/BUSpaRse/LICENSE">Text</a>
		    </td>
		    <td class="docFixedWidth">&nbsp;</td>
		    <td>LICENSE</td>
		</tr>
		
	    

	    

    </table>

    <h3 id="details">Details</h3>
    
    <table class="details">
	<tr class="row_odd">
	    <td>biocViews</td>
	    <td><a href="../../BiocViews.html#___RNASeq">RNASeq</a>, <a href="../../BiocViews.html#___SingleCell">SingleCell</a>, <a href="../../BiocViews.html#___Software">Software</a>, <a href="../../BiocViews.html#___WorkflowStep">WorkflowStep</a></td>
	</tr>

	<tr class="row_even">
	    <td>Version</td>
	    <td>1.2.2</td>
	</tr>

	
	    <tr id="since" class="row_odd">
		<td>In Bioconductor since</td>
		<td>BioC 3.10 (R-3.6) (1 year)</td>
	    </tr>
	



	<tr class="row_even">
	    <td>License</td>
	    
                <td>BSD_2_clause + file <a href = "../licenses/BUSpaRse/LICENSE">LICENSE</a></td>
            
	</tr>

	<tr class="row_odd">
	    <td>Depends</td>
	    <td>R (>= 3.6)</td>
	</tr>

	<tr class="row_even">
	    <td>Imports</td>
	    <td><a href="../../bioc/html/AnnotationDbi.html">AnnotationDbi</a>, <a href="../../bioc/html/AnnotationFilter.html">AnnotationFilter</a>, <a href="../../bioc/html/biomaRt.html">biomaRt</a>, <a href="../../bioc/html/BiocGenerics.html">BiocGenerics</a>, <a href="../../bioc/html/Biostrings.html">Biostrings</a>, <a href="../../bioc/html/BSgenome.html">BSgenome</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/dplyr/index.html">dplyr</a>, <a href="../../bioc/html/ensembldb.html">ensembldb</a>, <a href="../../bioc/html/GenomeInfoDb.html">GenomeInfoDb</a>, <a href="../../bioc/html/GenomicFeatures.html">GenomicFeatures</a>, <a href="../../bioc/html/GenomicRanges.html">GenomicRanges</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/ggplot2/index.html">ggplot2</a>, <a href="../../bioc/html/IRanges.html">IRanges</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/magrittr/index.html">magrittr</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/Matrix/index.html">Matrix</a>, methods, <a href="../../bioc/html/plyranges.html">plyranges</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/Rcpp/index.html">Rcpp</a>, <a href="../../bioc/html/S4Vectors.html">S4Vectors</a>, stats, <a class="cran_package" href="http://cran.rstudio.com/web/packages/stringr/index.html">stringr</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/tibble/index.html">tibble</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/tidyr/index.html">tidyr</a>, utils, <a class="cran_package" href="http://cran.rstudio.com/web/packages/zeallot/index.html">zeallot</a></td>
	</tr>

	<tr class="row_odd">
	    <td>LinkingTo</td>
	    <td><a class="cran_package" href="http://cran.rstudio.com/web/packages/Rcpp/index.html">Rcpp</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/RcppArmadillo/index.html">RcppArmadillo</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/RcppProgress/index.html">RcppProgress</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/BH/index.html">BH</a></td>
	</tr>

	<tr class="row_even">
	    <td>Suggests</td>
	    <td><a class="cran_package" href="http://cran.rstudio.com/web/packages/knitr/index.html">knitr</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/rmarkdown/index.html">rmarkdown</a>, <a class="cran_package" href="http://cran.rstudio.com/web/packages/testthat/index.html">testthat</a>, <a href="../../bioc/html/BiocStyle.html">BiocStyle</a>, <a href="../../data/experiment/html/TENxBUSData.html">TENxBUSData</a>, <a href="../../data/annotation/html/TxDb.Hsapiens.UCSC.hg38.knownGene.html">TxDb.Hsapiens.UCSC.hg38.knownGene</a>, <a href="../../data/annotation/html/BSgenome.Hsapiens.UCSC.hg38.html">BSgenome.Hsapiens.UCSC.hg38</a>, <a href="../../data/annotation/html/EnsDb.Hsapiens.v86.html">EnsDb.Hsapiens.v86</a></td>
	</tr>

	<tr class="row_odd">
	    <td>SystemRequirements</td>
	    <td>GNU make</td>
	</tr>

	<tr class="row_even">
	    <td>Enhances</td>
	    <td></td>
	</tr>

	<tr class="row_odd">
	    <td>URL</td>
	    <td><a href="https://github.com/BUStools/BUSpaRse">https://github.com/BUStools/BUSpaRse</a> </td>
	</tr>

	
	    <tr class="row_even">
		<td>BugReports</td>
		<td><a href="https://github.com/BUStools/BUSpaRse/issues">https://github.com/BUStools/BUSpaRse/issues</a> </td>
	    </tr>
	

	<tr class="row_odd">
	    <td>Depends On Me</td>
	    <td></td>
	</tr>

	<tr class="row_even">
	    <td>Imports Me</td>
	    <td></td>
	</tr>

	<tr class="row_odd">
	    <td>Suggests Me</td>
	    <td></td>
	</tr>

	<tr class="row_even">
	    <td>Links To Me</td>
	    <td></td>
	</tr>

	
	    <tr class="row_odd">
		<td><a href="http://bioconductor.org/checkResults/3.11/bioc-LATEST/BUSpaRse/">Build Report</a></td>
		<td>&nbsp;</td>
	    </tr>
	

    </table>


    <h3 id="archives">Package Archives</h3>

    <p>Follow <a href="/install/#install-bioconductor-packages">
    Installation</a> instructions to use this
    package in your R session.</p>

    

    <table>
	<tr class="row_odd">
	    <td>Source Package</td>
	    <td class="rpack"><a onClick="javascript: pageTracker._trackPageview('../src/contrib/BUSpaRse_1.2.2.tar.gz'); " href="../src/contrib/BUSpaRse_1.2.2.tar.gz">
		BUSpaRse_1.2.2.tar.gz</a></td>
	    </tr>

	    <tr class="row_even">
		<td>Windows Binary</td>
		<td class="rpack">
		    
		    
		    <a onClick="javascript: pageTracker._trackPageview('../bin/windows/contrib/4.0/BUSpaRse_1.2.2.zip'); " href="../bin/windows/contrib/4.0/BUSpaRse_1.2.2.zip">
			BUSpaRse_1.2.2.zip</a> (32- &amp; 64-bit)
		    
		    </td>
		</tr>


		


		    <tr class="row_odd">
			<td>macOS 10.13 (High Sierra)</td>
			<td class="rpack"><a onClick="javascript: pageTracker._trackPageview('../bin/macosx/contrib/4.0/BUSpaRse_1.2.2.tgz'); " href="../bin/macosx/contrib/4.0/BUSpaRse_1.2.2.tgz">
			    BUSpaRse_1.2.2.tgz</td>
		    </tr>


		

		
		    <tr class="row_even">
			<td id="svn_source">Source Repository</td>
			<td>git clone https://git.bioconductor.org/packages/BUSpaRse</td>
		    </tr>
		    <tr class="row_odd">
			<td id="svn_source">Source Repository (Developer Access)</td>
			<td>git clone git@git.bioconductor.org:packages/BUSpaRse</td>
		    </tr>
		

		    <tr class="row_even">
			<td>Package Short Url</td>
			<td><a title="For citation in publications, etc., please use DOI: 10.18129/B9.bioc.BUSpaRse" href="/packages/BUSpaRse/">https://bioconductor.org/packages/BUSpaRse/</a></td>
		    </tr>


		    <tr class="row_odd">
			<td>Package Downloads Report</td>
			<td><a href="http://bioconductor.org/packages/stats/bioc/BUSpaRse/">Download Stats</a></td>
		    </tr>

		

		</table>

</div>

	
	

	 
	
	  </div>
	  <div id="RightRail" class="RightRail">
	  <a name="section-navigation"></a> <!-- accessibility anchor -->
	  
  


  
    <div class="shaded_box">
  <img src="/images/inv.gif" align="right" height="200" width="1" alt=""/>
  <p class="box_header">Documentation <span class="olive">&raquo;</span></p>
  <p><em>Bioconductor</em></p>
  <ul>
    <li>Package <a href="/help/package-vignettes/">vignettes</a> and manuals.
    <li><a href="/packages/release/workflows/">Workflows</a> for
    learning and use.</li>
    <li><a href="/help/course-materials/">Course and conference</a>
      material.</li>
    <li><a href="https://www.youtube.com/user/bioconductor">Videos</a>.</li>
    <li>Community <a href="/help/community/">resources</a>
      and <a href="https://support.bioconductor.org/t/Tutorials/">tutorials</a>.</li>
  </ul>
  <p><em>R</em> / <a href="http://cran.r-project.org/">CRAN</a> packages and
   <a href="http://www.r-project.org/other-docs.html">documentation</a></p>
</div>

  
    <div class="shaded_box">
  <img src="/images/inv.gif" align="right" height="200" width="1" alt=""/>
  <p class="box_header"><a href="https://support.bioconductor.org/">Support</a>
  <span class="olive">&raquo;</span></p>
  <p>
    Please read the <a href="/help/support/posting-guide/">posting
    guide</a>. Post questions about Bioconductor
    to one of the following locations:</p>
  <ul>
    <li><a href="https://support.bioconductor.org/">Support site</a> -
        for questions about Bioconductor packages</li>
    <li><a href="/help/support/#bioc-devel">Bioc-devel</a> mailing
        list - for package developers</li>
  </ul>
</div>

  


	

      </div>

      <div id="SiteGlobalFooter" class="SiteGlobalFooter">

  <span class="global_footer_logo_bc noprint"><img src="/images/logo_global_footer_bioconductor.gif" height="51" width="154" alt=""/></span>

  <div class="attribution_copyright">
    <p>Contact us: <a href="https://support.bioconductor.org/">support.bioconductor.org</a></p>
    <p>Copyright &copy; 2003 - 2020, Bioconductor</p>
  </div>

  <a name="site-map"></a> <!-- accessibility anchor -->
  <ul class="footer_nav_list noprint">
    <li class="footer_nav_list_element footer_nav_list_element_0">
      <b><a href="/index.html">Home</a></b>
    </li>
    <li class="footer_nav_list_element footer_nav_list_element_1">
      <ul>
        <li><b><a href="/install/index.html">Install</a></b></li>
        <li><a href="/install/index.html#install-R">Install R</a></li>
        <li><a href="/install/index.html#find-bioconductor-packages">Find Bioconductor Packages</a></li>
        <li><a href="/install/index.html#install-bioconductor-packages">Install Bioconductor Packages</a></li>
        <li><a href="/install/index.html#update-bioconductor-packages">Update Bioconductor Packages</a></li>
      </ul>
    </li>
    <li class="footer_nav_list_element footer_nav_list_element_2">
      <ul>
        <li><b><a href="/help/index.html">Help</a></b></li>
        <li><a href="/packages/release/workflows/">Workflows</a></li>
        <li><a href="/help/package-vignettes/">Package Vignettes</a></li>
        <li><a href="/help/faq/">FAQ</a></li>
        <li><a href="/help/support/">Support</a></li>
        <li><a href="http://cran.r-project.org/">Using R</a></li>
        <li><a href="/help/course-materials/">Courses</a></li>
        <li><a href="/help/publications/">Publications</a></li>
        <li><a href="/help/bioconductor-cloud-ami/">Cloud AMI</a></li>
        <li><a href="/help/community/">Community Resources</a></li>

      </ul>
    </li>
    <li class="footer_nav_list_element footer_nav_list_element_3">
      <ul>
        <li><b><a href="/developers/index.html">Developers</a></b></li>
		<li><a href="/developers/package-guidelines/">Package Guidelines</a></li>
		<li><a href="/developers/package-submission/">Package Submission</a></li>
		<li><a href="/developers/release-schedule/">Release Schedule</a></li>
		<li><a href="/developers/source-control/">Source Control</a></li>
      </ul>
    </li>
    <li class="footer_nav_list_element footer_nav_list_element_4">
      <ul>
        <li><b><a href="/about/index.html">About</a></b></li>
        <li><a href="/about/annual-reports/">Annual Reports</a></li>
        <li><a href="/about/core-team/">Core Team</a></li>
        <li><a href="/about/mirrors/">Mirrors</a></li>
        <li><a href="/about/related-projects/">Related Projects</a></li>
        <li><a href="/about/code-of-conduct/">Code of Conduct</a></li>
     </ul>
    </li>
  </ul>
  <br style="clear:both"/>
  &nbsp;

</div>


<div id="SiteMasthead" class="SiteMasthead">

  <a name="site-navigation"></a> <!-- accessibility anchor -->

  <span class="logo_vanity_bar noprint"></span>

  <a href="/">
	<img src="/images/logo_bioconductor.gif" border="0" class="masthead_logo" height="78" width="260" alt="Bioconductor - open source software for bioinformatics"/>
  </a>

  <div id="SiteMastheadRight" class="SiteMastheadRight">
    <div id="SiteMastheadRightBackground" class="SiteMastheadRightBackground">

      <a name="site-search"></a> <!-- accessibility anchor -->
      <form class="site_search" id="search_form" method="GET"
            action="/help/search/index.html">
        Search: <input id="q" name="q" />
      </form>

      <ul class="masthead_nav noprint">
        <li class="masthead_nav_element" id="masthead_nav_element_1">
          <a href="/">Home</a>
        </li>
        <li class="masthead_nav_element" id="masthead_nav_element_2">
          <a href="/install/">Install</a>
        </li>
        <li class="masthead_nav_element" id="masthead_nav_element_3">
          <a href="/help/">Help</a>
        </li>
        <li class="masthead_nav_element" id="masthead_nav_element_4">
          <a href="/developers/">Developers</a>
        </li>
        <li class="masthead_nav_element" id="masthead_nav_element_5">
          <a href="/about/">About</a>
        </li>
      </ul>

    </div>
  </div>

</div>

    </div>
  </body>
</html>
