Changes

From Genome Analysis Wiki
Jump to navigationJump to search

C++ Library: libStatGen (view source)

Revision as of 15:54, 31 January 2017

1,521 bytes removed ,  15:54, 31 January 2017
→‎Library Documentation
Line 22: Line 22:     
= Copyrights =
 
= Copyrights =
−
'''If you use this software, please e-mail me, Mary Kate Trost, at mktrost@umich.edu'''
+
'''If you use this software, please e-mail me, Mary Kate Wing, at mktrost@umich.edu'''
    
Here are links to the copyrights for our code and some of the utilities it uses:
 
Here are links to the copyrights for our code and some of the utilities it uses:
Line 30: Line 30:  
Copies of these can be found in our library under libStatGen/copyrights/.
 
Copies of these can be found in our library under libStatGen/copyrights/.
   −
= Where to Find It =
+
= Join in libStatGen mailing list =
−
libStatGen can be found at: [https://github.com/statgen/libStatGen https://github.com/statgen/libStatGen]
     −
libStatGen can also be found within certain releases of statgen tools.  The tools will have a release version that also includes a copy of libStatGen.
+
Please join in the [http://groups.google.com/group/libStatGen libStatGen Google Group] to ask / discuss / comment about this library.
      −
On github, you can both browse and download the latest version of the library, as well as explore the history of changes.
+
= Troubleshooting =
 +
If you are having trouble compiling any of the versions, check [[libStatGen Troubleshooting]] for help.  If that does not solve your problem, email me for support.
   −
You can access the latest version with or without using git.
     −
== Using Git To Track the Current Development Version ==
+
= Where to Find It =
   −
=== Clone (get your own copy) ===
+
{{ToolGitRepo|repoName=libStatGen|libStatGen=true|libBaseName=libStatGen}}
−
You can create your own git clone (copy) using:
  −
git clone https://github.com/statgen/libStatGen.git
  −
or
  −
git clone git://github.com/statgen/libStatGen.git
     −
Either of these commands create a directory called <code>libStatGen</code> in the current directory.
+
== Releases ==
−
 
  −
Then just <code>cd libStatGen</code> and [[C++ Library: libStatGen#Building the Library|compile the library]].
  −
 
  −
=== Get the latest Updates (update your copy) ===
  −
To update your copy to the latest version (a major advantage of using git):
  −
# <code>cd pathToYourCopy/libStatGen</code>
  −
# <code>make clean</code>
  −
# <code>git pull</code>
  −
# <code>make all</code>
  −
 
  −
=== Git Refresher ===
  −
If you decide to use git, but need a refresher, see [[How To Use Git]] or [https://statgen.sph.umich.edu/wiki/How_To_Use_Git Notes on how to use git] (if you have access)
  −
 
  −
 
  −
== Getting the Latest Development Version without Using Git ==
  −
Periodically download the latest copy from github from the "Downloads" link on the webpage or [https://github.com/statgen/libStatGen/archives/master https://github.com/statgen/libStatGen/archives/master]. 
  −
 
  −
The downloaded tar file is named "statgen-libStatGen-''someHexNumber''.tar.gz".  The directory created when it is untared shares the same base name.  I recommend that you do not change the name of the directory.  If you want one called libStatGen, create a link to this directory.  The hex number in the directory name identifies the version of the library that you downloaded and is necessary to easily troubleshoot any issues you encounter.  If you must rename the directory, be sure to record the hex number that was on the download for future reference.
  −
 
  −
 
  −
== Released Versions ==
   
Released Versions are documented at [[libStatGen Download]]
 
Released Versions are documented at [[libStatGen Download]]
−
      
= What has changed =
 
= What has changed =
Line 83: Line 56:  
= Library Documentation =
 
= Library Documentation =
 
Latest Doxygen documentation:
 
Latest Doxygen documentation:
−
[http://www.sph.umich.edu/csg/mktrost/doxygen/2011_08_23/ 8/23/11 Library Documentation in Doxygen]
+
<!-- <a href="http://csg.sph.umich.edu//abecasis/GOLD/ -->
 +
<!-- [http://www.sph.umich.edu/csg/mktrost/doxygen/current/ Current Library Documentation in Doxygen] -->
 +
[http://csg.sph.umich.edu//mktrost/doxygen/current/ Current Library Documentation in Doxygen]
   −
Additional documentation: <span style="color:#B22222">Currently outdated, but updates will be coming soon</span>
+
Additional documentation:  
 
* [[libStatGen: general]] - General classes for file processing and performing common tasks (used by most other libraries).
 
* [[libStatGen: general]] - General classes for file processing and performing common tasks (used by most other libraries).
 
* [[libStatGen: BAM]] - Classes specific for reading/writing/analyzing SAM/BAM files.
 
* [[libStatGen: BAM]] - Classes specific for reading/writing/analyzing SAM/BAM files.
 
* [[libStatGen: GLF]] - Classes specific for reading/writing/analyzing GLF files.
 
* [[libStatGen: GLF]] - Classes specific for reading/writing/analyzing GLF files.
 
* [[libStatGen: FASTQ]] - Classes specific for reading/writing/analyzing FastQ files.
 
* [[libStatGen: FASTQ]] - Classes specific for reading/writing/analyzing FastQ files.
 +
* [[libStatGen: ASP]] - Classes specific for reading/writing/analyzing ASP files.
 +
* [[libStatGen: VCF]] - Classes specific for reading/writing/analyzing VCF files.
    
= Using the Library =
 
= Using the Library =
Line 96: Line 73:  
** g++
 
** g++
 
** development version of zlib (zlib1g-dev on ubuntu)
 
** development version of zlib (zlib1g-dev on ubuntu)
−
** openssl and md5 (libssl-dev on ubuntu)
   
* Compiles on Linux/Unix
 
* Compiles on Linux/Unix
   Line 224: Line 200:       −
= Troubleshooting =
+
= How To Use the APIs =
−
If you are having trouble compiling any of the versions, check [[libStatGen Troubleshooting]] for help.  If that does not solve your problem, email me for support.
+
More coming soon, see: http://genome.sph.umich.edu/wiki/Sam_Library_Usage_Examples
 +
 
 +
[[LibStatGen: ASP#API for Reading ASP Files| ASP APIs]]
 +
 
 +
[[LibStatGen: VCF#API for Reading VCF Files| VCF APIs]]
Ppwhite
96

edits

Retrieved from "http://genome.sph.umich.edu/wiki/Special:MobileDiff/3549...14569"

Navigation menu