README.md

In matthuska/tRap: A biophysical model for transcription factor binding affinities

tRap

tRap is an R package that can be used to calculate the predicted binding affinity of a transcription factor to a DNA or RNA sequence. It implements the model described in Roider et al 2007.

Installation

You will need the latest version of devtools. First install the release version:

install.packages("devtools")

then update it to the latest developement version:

devtools::install_github("devtools")

Finally you can install the latest development version of tRap from github with:

devtools::install_github("matthuska/tRap")

If you're in our group at the MPIMG then you can also install a package containing pre-processed TRANSFAC matrices. Sorry this is not available to people outside of our group because TRANSFAC is a commercial database.

devtools::install_local("/home/huska/pub/tRapTransfac_0.1.tar.gz")

Developing

git

We use the fork & pull model for developement (based on a README from the Shogun project)

Visit the tRap github page and click on the Fork button. Then clone your copy of the repo and add the original tRap repository as upstream:

git clone [e-mail]:<your id>/tRap.git
git remote add upstream [e-mail]:matthuska/tRap.git
git checkout --track origin/master

Now you're ready to work on your feature. First create a branch:

git checkout -b new_feature_name

and now you can develop your code and commit to this branch.

Once the feature is done, rebase your branch against the current upstream master:

git fetch upstream
git checkout master
git rebase upstream/master
git checkout new_feature_name
git rebase master

And now you can push into your repository:

git push

Now go to the github website and do a pull request.

R development

After creating a branch in your local git repository, modify the R or C++ code however you need and then run R from inside the root of the package's directory (e.g. tRap/) and run a few devtools commands:

library(devtools)
load_all() # this should recompile the C++ code
check()    # does some/all of the above, as well as running R CMD check

There are a few other useful devtools commands:

install()  # install the package in your R library directory
document() # just rebuilds the documentation
test()     # just runs all tests
build()    # build a binary package

For more information check out the devtools site.

matthuska/tRap documentation built on May 21, 2019, 1:23 p.m.