Git Product home page Git Product logo

cancerbits's Introduction

R Package: canceRbits

Wrapper and helper functions commonly used by the Developmental Cancer Genomics group at St. Anna Children's Cancer Research Institute.

To install from github

To install the latest version

remotes::install_github(repo = 'cancerbits/canceRbits')

For reproducibility, e.g. in a dockerfile, use approaches below

To install a specific version given its tag

remotes::install_github(repo = 'cancerbits/canceRbits', ref = 'v0.1.2')

(All tags are listed here)

To install a specific commit

remotes::install_github(repo = 'cancerbits/canceRbits', ref = '10b959a')

(All commits are listed here)

Workflow for updating the package

  • Add/edit one or more .R files in R directory
    • Make sure to include roxygen documentation
  • run devtools::document()
  • add required packages to NAMESPACE file (if there are new ones)
  • (optional) Edit DESCRIPTION file (e.g. add your name, bump the version number)
  • (optional) Edit overall package documentation in R/canceRbits.R
  • (optional but strongly suggested) Add unit test for new functionality (in tests/testthat/)
  • check whether package is still OK via devtools::check(document = FALSE) or via Rstudio menu: 'Build' > 'Check Package'

Conventions

Exported functions have a cb_ prefix in their name.

Suggested reading

R packages by Hadley Wickham and Jenny Bryan

useful cheat sheet

cancerbits's People

Stargazers

avatar

Watchers

avatar avatar avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.