Commit information:
Commit id: d498610a263582b36dd63503829ba5c7befca2c6
updated README
Committed by: Kasper Daniel Hansen
Author Name: Kasper Daniel Hansen
Commit date: 2014-10-02 22:23:06 -0400
Author date: 2014-10-02 22:23:06 -0400
git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/Rgraphviz@94891 bc3139a8-67e5-0310-9ffc-ced21a209358
... | ... |
@@ -1,4 +1,13 @@ |
1 |
-# Rgraphviz |
|
1 |
+# R package: Rgraphviz |
|
2 |
+ |
|
3 |
+This is the developer version of Bioconductor package [Rgraphviz](http://bioconductor.org/packages/devel/bioc/html/Rgraphviz.html). Install in R as: |
|
4 |
+ |
|
5 |
+```r |
|
6 |
+source('http://bioconductor.org/biocLite.R') |
|
7 |
+biocLite(Rgraphviz') |
|
8 |
+``` |
|
9 |
+ |
|
10 |
+# Additional installation tips |
|
2 | 11 |
|
3 | 12 |
Rgraphviz now comes bundles with Graphviz. This should greatly simplify |
4 | 13 |
installation on all platforms, compared with earlier versions. |
... | ... |
@@ -6,32 +15,32 @@ installation on all platforms, compared with earlier versions. |
6 | 15 |
While it should not be necessary, we still allow for the use of an external |
7 | 16 |
Graphviz (external to Rgraphviz) at install time, except on Windows (this used |
8 | 17 |
to be supported on Windows but this is no longer true). This is indicated by |
9 |
-the configure option --with-graphviz. |
|
18 |
+the configure option `--with-graphviz`. |
|
10 | 19 |
|
11 | 20 |
A direct specification of an external Graphviz at install time would be |
12 |
- R CMD INSTALL --configure-args='--with-graphviz=/usr/local' Rgraphviz_*.tar.gz |
|
21 |
+ |
|
22 |
+```{bash} |
|
23 |
+R CMD INSTALL --configure-args='--with-graphviz=/usr/local' Rgraphviz_*.tar.gz |
|
24 |
+``` |
|
13 | 25 |
In this case (with $DIR=/usr/local), the configure script assumes the presence |
14 |
-of |
|
15 |
- $DIR/include/graphviz |
|
16 |
- $DIR/lib/graphviz |
|
26 |
+of |
|
27 |
+```{bash} |
|
28 |
+$DIR/include/graphviz |
|
29 |
+$DIR/lib/graphviz |
|
30 |
+``` |
|
17 | 31 |
as is the default when Graphviz is installed. It is not possible to directly |
18 |
-specifify these two directories, only $DIR |
|
32 |
+specifify these two directories, only `$DIR` |
|
19 | 33 |
|
20 | 34 |
It is also possible to get Rgraphviz to search for Graphviz, by leaving the |
35 |
+`--with-graphviz` option empty, as |
|
21 | 36 |
|
22 |
- R CMD INSTALL --configure-args='--with-graphviz' Rgraphviz_*.tar.gz |
|
37 |
+```{bash} |
|
38 |
+R CMD INSTALL --configure-args='--with-graphviz' Rgraphviz_*.tar.gz |
|
39 |
+``` |
|
23 | 40 |
|
24 | 41 |
In this case, Rgraphviz will search for Graphviz using the following methods |
25 |
- (1) First try pkg-config |
|
26 |
- (2) See if Graphviz is in its default location of /usr/local |
|
27 |
- |
|
28 |
- |
|
29 |
-## Devel repository |
|
30 |
- |
|
31 |
-The devel repository for Rgraphviz is at |
|
32 |
- |
|
33 |
-https://github.com/kasperdanielhansen/Rgraphviz |
|
42 |
+1. First try pkg-config |
|
43 |
+2. See if Graphviz is in its default location of `/usr/local` |
|
34 | 44 |
|
35 | 45 |
## Notes |
36 | 46 |
|
... | ... |
@@ -39,4 +48,7 @@ The release version of Graphviz 2.28 contains bugs that makes it not work with |
39 | 48 |
Rgraphviz for certain layout options. The patches to the bundled Graphviz |
40 | 49 |
2.28.0 are included in package. |
41 | 50 |
|
51 |
+## R CMD check results |
|
52 |
+Bioconductor: [Multiple platform build/check report](http://master.bioconductor.org/checkResults/devel/bioc-LATEST/Rgraphviz/) |
|
53 |
+ |
|
42 | 54 |
|