The Bioconductor project is maintained in a Subversion source control system. Maintainers can also access their packages through git and Github using the Bioconductor Git mirrors.
Read-only access to our svn repository is available with
To check out (co) all packages in the software repository (~3 GB) use:
svn co https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks Rpacks-devel
This creates a copy of all packages on your local machine. Specify a name other than “Rpacks-devel” if you want a top-level directory with different name.
To check out the code for the Biobase package use:
svn co https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/Biobase
The check out command uses the directory name in the repository if the destination name is not specified.
svn updatewill update your check out from the server to get any new changes.
svn addfoo will add foo to the repository (note that unlike CVS this is a recursive add. Use the -N switch if you don’t want this behavior).
svn deletefoo will delete foo. If foo is a file it is removed from your local copy as well. If it is a directory it is not but is scheduled for deletion.
svn copyfoo bar will make a copy of foo named bar and copy the history.
svn movefoo bar is the same as copy except foo gets deleted.
svn commitcommits your changes. Much like CVS you can choose to specify a file (or files) or leave it blank and it will commit everything.
Some other commands:
svn statusfoo will show you information about the file, particularly changes that you’ve made.
svn difffoo will show you the exact diff of your changes to the server
svn revertfoo will bring you back to the server copy.
svn logfoo will show the log history for that file.
Many of these commands have additional arguments. Get help on diff, for example, like this:
svn help diff
The Subversion Book has more complete documentation and examples for all the commands and options.
Almost all development is on the trunk (‘devel’) branch of the SVN
repository, as indicated by the ‘trunk’ part of the URL in the
examples above. All bug fixes, new features and major changes are
introduced in devel. Each commit should include a bump in the
portion of the
If you commit to trunk before 5:00 PM New York time, your changes will build overnight and be reflected in the next day’s build report which should appear around 9:00 AM New York time.
Only bug fixes should be back-ported to the release branch. This is so that users of the release branch have a stable environment in which to get their work done.
If you wish to have a bug-fix made in the devel branch also available in the current release branch, you first need to take note of the revision number from your commit, for example,
$ svn commit -m "Sample commit" Adding Rpacks\Biobase\DESCRIPTION Sending Rpacks\Biobase\DESCRIPTION Transmitting file data .. Committed revision 140.
was revision 140. The changeset you want is
You’ll need to have checked out the branches subdirectory, which is separate from trunk. If you have only checked out the madman subdirectory previously, you’ll need to also check out the appropriate branch subdirectory:
svn co https://hedgehog.fhcrc.org/bioconductor/branches/RELEASE_3_4/madman/Rpacks/MYPACKAGENAME
Merge your changes from the trunk to the release branch, check and fix any conflicts, and commit. So, from your release branch directory (e.g. RELEASE_3_4/madman/Rpacks/MYPACKAGENAME):
svn merge -c140 https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/MYPACKAGENAME svn status # Look for C, indicating a conflict # fix conflicts... (remember to use svn resolve for each) svn commit -m "merged r140 from trunk"
The root of the Bioconductor experiment data svn repository is https://hedgehog.fhcrc.org/bioc-data/trunk/experiment. Experiment data packages are divided into two components: pkgs (containing all but the data files) and data_store (containing the data files). To obtain a specific experiment data package first check out the package infrastructure then fold the data in using the Python script https://hedgehog.fhcrc.org/bioc-data/trunk/experiment/pkgs/add_data.py on the exported package. Here are the commands to check out the affydata package:
## export add_data.py script svn export https://hedgehog.fhcrc.org/bioc-data/trunk/experiment/pkgs/add_data.py ## check out the package, without the large data svn co https://hedgehog.fhcrc.org/bioc-data/trunk/experiment/pkgs/affydata ## add the large data ./add_data.py affydata
Note that experiment data packages are only built twice a week, on Wednesdays and Saturdays.
Updating the affydata package might involve commits to
data_store/affydata (if data is being updated), to
(if documentation is being updated) or both (e.g., a data change in
data_store/affydata coupled with a version bump in
pkgs/affydata/DESCRIPTION). The file
pkgs/affydata/external_data_store.txt would be appropriate if the
organization of the data in the data_store were changed. A typical
work flow might create a subset of the experiment data repository
svn co -N https://hedgehog.fhcrc.org/bioc-data/trunk/experiment cd experiment svn up pkgs/affydata data_store/affydata pkgs/add_data.py
make changes, and commit
svn ci pkgs/affydata data_store/affydata
Due to the size of the Annotation files these packages are not stored in svn. To update an existing Annotation package please make the new version available in dropbox (or similar) and send an email to email@example.com. A member of the Bioconductor team will add the package to the appropriate repository.
To contribute a new Annotation package please contact firstname.lastname@example.org for guidance.
One of the following steps should work:
Look in your email. Your SVN credentials were originally sent to you by a member of the Bioconductor team, probably with the subject line “congrats” or “congratulations”. The email by a member of the Bioconductor team, probably with a subject line containing “congrats” or “congratulations”. The email should contain the text “Information about your svn account”.
Go to your
~/.subversion/auth/svn.simple directory. There should
be one or more files whose names are long hexadecimal numbers. Use
grep to find out which file contains your username. If you don’t
know your username, it’s usually your first initial, a dot, and your
last name (all lowercase). So Jill User would be
$ grep -l j.user * 81a52e36a28dfd7750bd975f30c7998b
This indicates that your password can be found in the file called
81a52e36a28dfd7750bd975f30c7998b. Examine that file and you should
see something like:
password V 8 Z7oRUVH6
In this case,
Z7oRUVH6 is your password.
If you still can’t find your username or password, contact a member
of the Bioconductor team at
maintainer at bioconductor dot org.
Mention the package(s) that you maintain. We cannot send you
your password but we can ask for a new one to be generated, and send
it to you. It may take a day or two for the request to be processed.
Here is a list of possible issues:
Unrecognized URL scheme:
If you see “unrecognized URL scheme” when trying to access the
repository, it may indicate that your svn client does not support
HTTPS. You can verify the supported “modes” by examining the
svn --version. If you do not see support for HTTPS,
you will need to upgrade your client.
Username or password not recognized:
Most usernames we issue are in the form of an email address. It may
help to quote the user name:
--username="email@example.com". Try double and single quotes.
Need help arranging access to your package? Use contact information for new package submission.
Still unresolved? Ask on the bioc-devel mailing list.