diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..31d5365 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +inst/doc +docs diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..a6aad3d --- /dev/null +++ b/NEWS.md @@ -0,0 +1,8 @@ +# cputools 0.2 + +- Added functions to create Bioconductor, Travis and codecov shields + in markdown +- Added functions to make GitHub, Issues, package urls (see `pkg.R`) +- Added `pkgqst` to create a small section about questions and support + pointing to Github issues and/or Bioconductor support site. + \ No newline at end of file diff --git a/docs/authors.html b/docs/authors.html new file mode 100644 index 0000000..4f4840a --- /dev/null +++ b/docs/authors.html @@ -0,0 +1,100 @@ + + + + + + + + +Authors • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Authors

+
+ +
    +
  • +

    Laurent Gatto. Author, maintainer. +

    +
    • +
+ +
+ +
+ + + +
+ + + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..0c89403 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,125 @@ + + + + + + + +Various helper functions • cputools + + + + + + +
+
+ + + +
+
+ + + + +
+ +
+

+ Various helper functions

+

A set up helper functions to standardise some R and package development and documentation.

+

See also maker and the CPU wiki.

+

See cputools() for an list of functions:

+
library("cputools")
+cputools()
+
## cputools functions:
+##  biocVersions
+##  color_picker
+##  colour_picker
+##  cputools
+##  cpuwww
+##  darken
+##  ht
+##  lighten
+##  makeBiocBuildShield
+##  makeBiocCovrShield
+##  makeCodecovShield
+##  makeDatName
+##  makeFigName
+##  makeGithubIssuesUrl
+##  makeGithubPageUrl
+##  makeGithubUrl
+##  makeTravisShield
+##  pdfpng
+##  pkgqsts
+
+
+

+ Questions and support

+

To get help: - Open a GitHub issue

+
+
+
+ + + +
+ + + +
+ + + diff --git a/docs/jquery.sticky-kit.min.js b/docs/jquery.sticky-kit.min.js new file mode 100644 index 0000000..e2a3c6d --- /dev/null +++ b/docs/jquery.sticky-kit.min.js @@ -0,0 +1,9 @@ +/* + Sticky-kit v1.1.2 | WTFPL | Leaf Corcoran 2015 | http://leafo.net +*/ +(function(){var b,f;b=this.jQuery||window.jQuery;f=b(window);b.fn.stick_in_parent=function(d){var A,w,J,n,B,K,p,q,k,E,t;null==d&&(d={});t=d.sticky_class;B=d.inner_scrolling;E=d.recalc_every;k=d.parent;q=d.offset_top;p=d.spacer;w=d.bottoming;null==q&&(q=0);null==k&&(k=void 0);null==B&&(B=!0);null==t&&(t="is_stuck");A=b(document);null==w&&(w=!0);J=function(a,d,n,C,F,u,r,G){var v,H,m,D,I,c,g,x,y,z,h,l;if(!a.data("sticky_kit")){a.data("sticky_kit",!0);I=A.height();g=a.parent();null!=k&&(g=g.closest(k)); +if(!g.length)throw"failed to find stick parent";v=m=!1;(h=null!=p?p&&a.closest(p):b("
"))&&h.css("position",a.css("position"));x=function(){var c,f,e;if(!G&&(I=A.height(),c=parseInt(g.css("border-top-width"),10),f=parseInt(g.css("padding-top"),10),d=parseInt(g.css("padding-bottom"),10),n=g.offset().top+c+f,C=g.height(),m&&(v=m=!1,null==p&&(a.insertAfter(h),h.detach()),a.css({position:"",top:"",width:"",bottom:""}).removeClass(t),e=!0),F=a.offset().top-(parseInt(a.css("margin-top"),10)||0)-q, +u=a.outerHeight(!0),r=a.css("float"),h&&h.css({width:a.outerWidth(!0),height:u,display:a.css("display"),"vertical-align":a.css("vertical-align"),"float":r}),e))return l()};x();if(u!==C)return D=void 0,c=q,z=E,l=function(){var b,l,e,k;if(!G&&(e=!1,null!=z&&(--z,0>=z&&(z=E,x(),e=!0)),e||A.height()===I||x(),e=f.scrollTop(),null!=D&&(l=e-D),D=e,m?(w&&(k=e+u+c>C+n,v&&!k&&(v=!1,a.css({position:"fixed",bottom:"",top:c}).trigger("sticky_kit:unbottom"))),eb&&!v&&(c-=l,c=Math.max(b-u,c),c=Math.min(q,c),m&&a.css({top:c+"px"})))):e>F&&(m=!0,b={position:"fixed",top:c},b.width="border-box"===a.css("box-sizing")?a.outerWidth()+"px":a.width()+"px",a.css(b).addClass(t),null==p&&(a.after(h),"left"!==r&&"right"!==r||h.append(a)),a.trigger("sticky_kit:stick")),m&&w&&(null==k&&(k=e+u+c>C+n),!v&&k)))return v=!0,"static"===g.css("position")&&g.css({position:"relative"}), +a.css({position:"absolute",bottom:d,top:"auto"}).trigger("sticky_kit:bottom")},y=function(){x();return l()},H=function(){G=!0;f.off("touchmove",l);f.off("scroll",l);f.off("resize",y);b(document.body).off("sticky_kit:recalc",y);a.off("sticky_kit:detach",H);a.removeData("sticky_kit");a.css({position:"",bottom:"",top:"",width:""});g.position("position","");if(m)return null==p&&("left"!==r&&"right"!==r||a.insertAfter(h),h.remove()),a.removeClass(t)},f.on("touchmove",l),f.on("scroll",l),f.on("resize", +y),b(document.body).on("sticky_kit:recalc",y),a.on("sticky_kit:detach",H),setTimeout(l,0)}};n=0;for(K=this.length;n + + + + + diff --git a/docs/news/index.html b/docs/news/index.html new file mode 100644 index 0000000..70dc14f --- /dev/null +++ b/docs/news/index.html @@ -0,0 +1,111 @@ + + + + + + + + +All news • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ +
+
+

Change log All releases

+
+ +
+
+

+ cputools 0.2

+
  • Added functions to create Bioconductor, Travis and codecov shields in markdown
    • +
  • Added functions to make GitHub, Issues, package urls (see pkg.R)
    • +
  • Added pkgqst to create a small section about questions and support pointing to Github issues and/or Bioconductor support site.
    • +
+
+
+ + + +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/pkgdown.css b/docs/pkgdown.css new file mode 100644 index 0000000..fd7b0ba --- /dev/null +++ b/docs/pkgdown.css @@ -0,0 +1,113 @@ +/* Sticker footer */ +body > .container { + display: flex; + padding-top: 60px; + min-height: calc(100vh); + flex-direction: column; +} + +body > .container .row { + flex: 1; +} + +footer { + margin-top: 45px; + padding: 35px 0 36px; + border-top: 1px solid #e5e5e5; + color: #666; + display: flex; +} +footer p { + margin-bottom: 0; +} +footer div { + flex: 1; +} +footer .pkgdown { + text-align: right; +} +footer p { + margin-bottom: 0; +} + +img.icon { + float: right; +} + +/* Section anchors ---------------------------------*/ + +.hasAnchor { + margin-left: -30px; +} + +a.anchor { + display:inline-block; + width: 30px; + height: 30px; + visibility: hidden; + + background-image: url(./link.svg); + background-repeat: no-repeat; + background-size: 20px 20px; + background-position: center center; +} + +.hasAnchor:hover a.anchor { + visibility: visible; +} + +/* Fixes for fixed navbar --------------------------*/ + +.contents h1, .contents h2, .contents h3, .contents h4 { + padding-top: 60px; + margin-top: -60px; +} + +/* Sidebar --------------------------*/ + +#sidebar { + margin-top: 30px; +} +#sidebar h2 { + font-size: 1.5em; + margin-top: 1em; +} + +#sidebar h2:first-child { + margin-top: 0; +} + +#sidebar .list-unstyled li { + margin-bottom: 0.5em; +} + +/* Syntax highlighting ---------------------------------------------------- */ + +code { + background-color: #f7f7f7; + color: #333; +} +code a { + color: #375f84; +} + +.warning { color: red; } +.message { font-weight: bolder; } +.error { color: red; font-weight: bolder; } + +.fl,.number {color:rgb(21,20,181);} +.fu,.functioncall {color:#264D66 ;} +.ch,.st,.string {color:#375D81 ;} +.kw,.keyword {color:black;} +.argument {color:#264D66 ;} +.co,.comment {color: #777;} +.formalargs {color: #264D66;} +.eqformalargs {color:#264D66;} +.slot {font-style:italic;} +.symbol {color:black ;} +.prompt {color:black ;} + +pre img { + background-color: #fff; + display: block; +} diff --git a/docs/pkgdown.js b/docs/pkgdown.js new file mode 100644 index 0000000..c8b38c4 --- /dev/null +++ b/docs/pkgdown.js @@ -0,0 +1,8 @@ +$(function() { + $("#sidebar").stick_in_parent({offset_top: 40}); + $('body').scrollspy({ + target: '#sidebar', + offset: 60 + }); + +}); diff --git a/docs/reference/biocVersions.html b/docs/reference/biocVersions.html new file mode 100644 index 0000000..dade8af --- /dev/null +++ b/docs/reference/biocVersions.html @@ -0,0 +1,123 @@ + + + + + + + + +Bioconductor version numbers — biocVersions • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Bioconductor version numbers

+
+ + +

This function returns the current release and devel Bioconductor +version numbers by parsing the +"http://www.bioconductor.org/js/versions.js" page.

+ + + 
biocVersions()
+ +

Value

+ +

A named character of length two with the + release and devel version numbers (in that + order).

+ + +

Examples

+ 
biocVersions()
#> release   devel 
+#>   "3.4"   "3.5"
+
+ +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/colour_picker.html b/docs/reference/colour_picker.html new file mode 100644 index 0000000..bf8b378 --- /dev/null +++ b/docs/reference/colour_picker.html @@ -0,0 +1,117 @@ + + + + + + + + +A simple colour picker — colour_picker • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

A simple colour picker

+
+ + +

A simple interface to manually pick colours from +colours(). Uses the current device is none is open.

+ + + 
colour_picker()
+
+color_picker()
+ +

Value

+ +

A vector of colours.

+ + +
+ +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/cputools.html b/docs/reference/cputools.html new file mode 100644 index 0000000..4a929f1 --- /dev/null +++ b/docs/reference/cputools.html @@ -0,0 +1,141 @@ + + + + + + + + +Available cputools functions — cputools • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Available cputools functions

+
+ + +

Print all available (exported) cputools functions.

+ + + 
cputools()
+ +

Value

+ +

Used for its side effect of print a list of available +helper functions.

+ + +

Examples

+ 
cputools()
#> cputools functions:
+#>  biocVersions
+#>  color_picker
+#>  colour_picker
+#>  cputools
+#>  cpuwww
+#>  darken
+#>  ht
+#>  lighten
+#>  makeBiocBuildShield
+#>  makeBiocCovrShield
+#>  makeCodecovShield
+#>  makeDatName
+#>  makeFigName
+#>  makeFileName
+#>  makeGithubIssuesUrl
+#>  makeGithubPageUrl
+#>  makeGithubUrl
+#>  makeTravisShield
+#>  mrkToUrl
+#>  pdfpng
+#>  pkgqsts
+#>  validUrl
+
+ +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/cpuwww.html b/docs/reference/cpuwww.html new file mode 100644 index 0000000..896acd2 --- /dev/null +++ b/docs/reference/cpuwww.html @@ -0,0 +1,118 @@ + + + + + + + + +Return the CPU webpage url. — cpuwww • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Return the CPU webpage url.

+
+ + +

Return the CPU webpage url.

+ + + 
cpuwww()
+ +

Value

+ +

The URL as a character

+ + +

Examples

+ 
cpuwww()
#> [1] "[Computational Proteomics Unit](http://cpu.sysbiol.cam.ac.uk/)"
+
+ +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/darken-2.png b/docs/reference/darken-2.png new file mode 100644 index 0000000..17cf005 Binary files /dev/null and b/docs/reference/darken-2.png differ diff --git a/docs/reference/darken.html b/docs/reference/darken.html new file mode 100644 index 0000000..425ae8d --- /dev/null +++ b/docs/reference/darken.html @@ -0,0 +1,135 @@ + + + + + + + + +darken and lighten colours — darken • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

darken and lighten colours

+
+ + +

Light and dark colours

+ + + 
darken(color, factor = 1.4)
+
+lighten(color, factor = 1.4)
+ +

Arguments

+
+
color
+
Colour name.
+
factor
+
Lightening/darkening factory.
+
+ +

Value

+ +

A new rgb colour

+ +

Details

+ +

From https://gist.github.com/Jfortin1/72ef064469d1703c6b30.

+ + +

Examples

+ 
darkFirebrick <- darken("firebrick")
+lightFirebrick <- lighten("firebrick")
+plot(c(1.5, 2, 2.5), c(1, 1.25, 1),
+     pch = 19, cex = 150,
+     col = c(darkFirebrick, "firebrick", lightFirebrick))
+
+ +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/ht.html b/docs/reference/ht.html new file mode 100644 index 0000000..f7b353c --- /dev/null +++ b/docs/reference/ht.html @@ -0,0 +1,137 @@ + + + + + + + + +head and tail — ht • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

head and tail

+
+ + +

Look at head and tail in one go.

+ + + 
ht(x, ...)
+ +

Arguments

+
+
x
+
An object for which head/tail are defined.
+
...
+
Additional parameters passed to head and tail.
+
+ +

Value

+ +

Invisibly returns NULL.

+ + +

Examples

+ 
ht(letters)
#> [1] "a" "b" "c" "d" "e" "f"
+#> ...
+#> [1] "u" "v" "w" "x" "y" "z"
ht(freeny.x, n = 3)
#>      lag quarterly revenue price index income level market potential
+#> [1,]               8.79636     4.70997      5.82110          12.9699
+#> [2,]               8.79236     4.70217      5.82558          12.9733
+#> [3,]               8.79137     4.68944      5.83112          12.9774
+#> ...
+#>       lag quarterly revenue price index income level market potential
+#> [37,]               9.71774     4.29627      6.18768          13.1579
+#> [38,]               9.74924     4.27839      6.19377          13.1625
+#> [39,]               9.77536     4.27789      6.20030          13.1664
+
+ +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000..130f715 --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,155 @@ + + + + + + + + +Function reference • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Function reference

+

version 0.2.0

+
+ +
+

All functions

+

+ + +

Bioconductor version numbers

+ + +

A simple colour picker

+ + +

Available cputools functions

+ + +

Return the CPU webpage url.

+ + +

darken and lighten colours

+ + +

head and tail

+ + +

Create a file name.

+ + +

Plot to pdf and png

+ + +

Generates Github URLs

+ + +

Generate the markdown code the a package shields.

+ + +
+
+ + +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/makeFigName.html b/docs/reference/makeFigName.html new file mode 100644 index 0000000..d41c321 --- /dev/null +++ b/docs/reference/makeFigName.html @@ -0,0 +1,147 @@ + + + + + + + + +Create a file name. — makeFigName • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Create a file name.

+
+ + +

Creates a file name given a prefix and other optional paramters +for a figure or data file. Also checks if file exists.

+ + + 
makeFigName(prefix, ext = "pdf", prefix0 = "Fig", date = TRUE,
+  path = ".")
+
+makeDatName(prefix, ext = "rda", prefix0 = "Dat", date = TRUE,
+  path = ".")
+ +

Arguments

+
+
prefix
+
A file specific prefix.
+
ext
+
The extension; default is pdf for a figure and +rda for a data file.
+
prefix0
+
The general prefix for figures. Default is +Fig for a figure and Dat for a data file.
+
date
+
Should the data (as reported by date) be used +as part of the file name? Default is TRUE.
+
path
+
The path to the file. Default is ".".
+
+ +

Value

+ +

A character with the figure file name.

+ +

Details

+ +

TODO: If file exists, create the next increment.

+ + +

Examples

+ 
makeFigName("foo")
#> [1] "./Fig-foo-Mon-Jan--2-17:04:25-2017.pdf"
makeFigName("foo", date = FALSE)
#> [1] "./Fig-foo.pdf"
makeDatName("foo", date = FALSE)
#> [1] "./Dat-foo.rda"
makeFigName("foo", path = "~/projects/big-project/figs")
#> [1] "~/projects/big-project/figs/Fig-foo-Mon-Jan--2-17:04:25-2017.pdf"
makeDatName("foo", path = "~/projects/big-project/Data")
#> [1] "~/projects/big-project/Data/Dat-foo-Mon-Jan--2-17:04:25-2017.rda"
+
+ +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/myfig.pdf b/docs/reference/myfig.pdf new file mode 100644 index 0000000..53b2f1b Binary files /dev/null and b/docs/reference/myfig.pdf differ diff --git a/docs/reference/myfig.png b/docs/reference/myfig.png new file mode 100644 index 0000000..dee18dc Binary files /dev/null and b/docs/reference/myfig.png differ diff --git a/docs/reference/pdfpng.html b/docs/reference/pdfpng.html new file mode 100644 index 0000000..bbda7f5 --- /dev/null +++ b/docs/reference/pdfpng.html @@ -0,0 +1,132 @@ + + + + + + + + +Plot to pdf and png — pdfpng • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Plot to pdf and png

+
+ + +

Plot to the pdf and png devices at once.

+ + + 
pdfpng(expr, fn)
+ +

Arguments

+
+
expr
+
A quoted expression that produces the desired plot.
+
fn
+
The file name (without extension).
+
+ +

Value

+ +

Produces the files fn.pdf and fn.png.

+ + +

Examples

+ 
p <- quote({
+   plot(1:10)
+   points(10:1)
+})
+pdfpng(p, "myfig")
#> pdf 
+#>   2
+
+ +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/pkgs.html b/docs/reference/pkgs.html new file mode 100644 index 0000000..bc6fe83 --- /dev/null +++ b/docs/reference/pkgs.html @@ -0,0 +1,160 @@ + + + + + + + + +Generates Github URLs — makeGithubUrl • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Generates Github URLs

+
+ + +

Generates a markdown section on where to ask questions about a +package.

+ + + 
makeGithubUrl(pkg, user = options()[["GitHubUserName"]])
+
+makeGithubPageUrl(pkg, user = options()[["GitHubUserName"]])
+
+makeGithubIssuesUrl(pkg, user = options()[["GitHubUserName"]])
+
+pkgqsts(pkg, github = TRUE, bioc = TRUE, level = 1L,
+  user = options()[["GitHubUserName"]])
+ +

Arguments

+
+
pkg
+
Mandatory character with the package name. Must +be of length one for codepkgqsts. Other functions +makeGithubPageUrl and makeGithubIssuesUrl are +vectorised.
+
user
+
Mandatory GitHub username. Default is to retrieve +options()[["GitHubUserName"]].
+
github
+
A logical (default is TRUE) defining +whether users can ask questions on GitHub issues.
+
bioc
+
A logical (default is TRUE) defining +whether users can ask questions on the Bioconductor support +forum.
+
level
+
Level for markdown sections. Default is 1L for +#. Use 2L for ## and so on.
+
+ +

Value

+ +

A character with Github URLs.

+

A character with Github page URLs.

+

A character with Github page URLs.

+

Invisibly returns NULL. Used for its side effect.

+ + +

Examples

+ 
makeGithubUrl("pRoloc", user = "lgatto")
#>                             pRoloc 
+#> "https://github.com/lgatto/pRoloc" 
makeGithubUrl(c("pRoloc", "pRolocGUI"), user = "lgatto")
#>                                pRoloc                             pRolocGUI 
+#>    "https://github.com/lgatto/pRoloc" "https://github.com/lgatto/pRolocGUI" 
makeGithubPageUrl("pRoloc", user = "lgatto")
#> [1] "https://lgatto.github.io/pRoloc"
makeGithubPageUrl(c("pRoloc", "pRolocGUI"), user = "lgatto")
#> [1] "https://lgatto.github.io/pRoloc"    "https://lgatto.github.io/pRolocGUI"
makeGithubIssuesUrl("pRoloc", user = "lgatto")
#> [1] "https://github.com/lgatto/pRoloc/issues"
makeGithubIssuesUrl(c("pRoloc", "pRolocGUI"), user = "lgatto")
#> [1] "https://github.com/lgatto/pRoloc/issues"   
+#> [2] "https://github.com/lgatto/pRolocGUI/issues"
pkgqsts("pRoloc", user = "lgatto")
#> # Questions and support
+#> To get help:
+#>  - Open a GitHub [issue](https://github.com/lgatto/pRoloc/issues)
+#>  - Post your question on the [Bioconductor support site](https://support.bioconductor.org/)
pkgqsts("cputools", bioc = FALSE, user = "lgatto")
#> # Questions and support
+#> To get help:
+#>  - Open a GitHub [issue](https://github.com/lgatto/cputools/issues)
+
+ +
+ +
+
+

Developed by Laurent Gatto.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/shields.html b/docs/reference/shields.html new file mode 100644 index 0000000..c30e03b --- /dev/null +++ b/docs/reference/shields.html @@ -0,0 +1,148 @@ + + + + + + + + +Generate the markdown code the a package shields. — makeTravisShield • cputools + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Generate the markdown code the a package shields.

+
+ + +

Functions to generate package travis-ci, codecov, Bioconductor +build status and Biocondcutor test coverage shields

+ + + 
makeTravisShield(pkg, user = options()[["GitHubUserName"]],
+  branch = "master")
+
+makeCodecovShield(pkg, user = options()[["GitHubUserName"]],
+  branch = "master")
+
+makeBiocBuildShield(pkg, branch = c("devel", "release"))
+
+makeBiocCovrShield(pkg, branch = c("devel", "release"))
+ +

Arguments

+
+
pkg
+
Mandatory character with the package name(s). If +of length greater than one, then must of of same length as +user and branch.
+
user
+
Mandatory GitHub username. Default is to retrieve +options()[["GitHubUserName"]]. Argument is not recycled +of more than one package is provided.
+
branch
+
Mandatory branch name. Default is +"master". Argument is not recycled of more than one +package is provided. For Bioconductor shields (functions +makeBiocBuildShield and makeBiocCovrShield), +branch is one of "devel" (default) or "release".
+
+ +

Value

+ +

A character with the shield in markdown.

+ + +

Examples

+ 
makeTravisShield("pRoloc", user = "lgatto")
#> [![Build Status](https://travis-ci.org/lgatto/pRoloc.svg?branch=master)](https://travis-ci.org/lgatto/pRoloc) 
## default user
+options(GitHubUserName = "ComputationalProteomicsUnit")
+makeCodecovShield("cputools")
#> [![codecov](https://codecov.io/gh/ComputationalProteomicsUnit/cputools/branch/master/graph/badge.svg)](https://codecov.io/gh/ComputationalProteomicsUnit/cputools) 
makeCodecovShield("MSnbase", user = "lgatto")
#> [![codecov](https://codecov.io/gh/lgatto/MSnbase/branch/master/graph/badge.svg)](https://codecov.io/gh/lgatto/MSnbase) 
makeBiocBuildShield("MSnbase")
#> [![Bioconductor devel build status](http://bioconductor.org/shields/build/devel/bioc/MSnbase.svg)](http://bioconductor.org/packages/devel/bioc/html/MSnbase.html) 
makeBiocBuildShield("MSnbase", branch = "release")
#> [![Bioconductor release build status](http://bioconductor.org/shields/build/release/bioc/MSnbase.svg)](http://bioconductor.org/packages/release/bioc/html/MSnbase.html) 
makeBiocCovrShield("MSnbase")
#> [![Bioconductor devel build status](https://bioconductor.org/shields/coverage/devel/MSnbase.svg)](https://codecov.io/github/Bioconductor-mirror/MSnbase/branch/master) 
makeBiocCovrShield("MSnbase", branch = "release")
#> [![Bioconductor release build status](https://bioconductor.org/shields/coverage/release/MSnbase.svg)](https://codecov.io/github/Bioconductor-mirror/MSnbase/branch/release-3.4)
+
+ +
+ + +
+ + +