Code Monkey home page Code Monkey logo

testpkg's Introduction

The TestPkg package

This is just a testing sandbox for package development.

Here are some check boxes

  • checkbox
  • checkbox
  • bullet

Overview

Just a test package to debug devtools and builds.

Installation

You can currently install TestPkg directly from the command line:

R --vanilla CMD INSTALL TestPkg

Or directly from GitHub with:

devtools::install_github("stufield/TestPkg")

Usage

To load TestPkg simply make a call to library() as usual:

library(TestPkg)

Notes about the package

  • The TestPkg package is easy to use.

  • There is some cool stuff we can do.

LICENSE

Please note that this SomaLogic, Inc. internal package is released with a LICENSE. By using in this package you agree to abide by its terms.

Created by Rmarkdown (v2.9) and R version 4.1.0 (2021-05-18).

testpkg's People

Contributors

stufield avatar

Watchers

avatar

testpkg's Issues

The `somaverse` Core

  • SomaReadr
  • SomaGlobals
  • SomaPlyr
  • SomaPlot
  • SomaClassify
  • SomaSurvival
  • SomaStabilitySelection
  • SomaPCA
  • SomaNormalization
  • SomaDB

somaverse with .lintr unit testing

  • SomaReadr
  • SomaGlobals
  • SomaPlyr
  • SomaPlot
  • SomaClassify
  • SomaSurvival
  • SomaStabilitySelection
  • SomaPCA
  • SomaMixedEffects
  • SomaNormalization
  • SomaDB
  • palantir
  • somaverse
  • SomaModelAssessment
  • SomaFeatureSelect
  • SomaPipeline

Release TestPkg 6.0.0

First release:

Prepare for release:

  • git pull
  • Check if any deprecation processes should be advanced, as described in Gradual deprecation
  • devtools::build_readme()
  • urlchecker::url_check()
  • devtools::check(remote = TRUE, manual = TRUE)
  • devtools::check_win_devel()
  • rhub::check_for_cran()
  • rhub::check(platform = 'ubuntu-rchk')
  • rhub::check_with_sanitizers()
  • git push
  • Draft blog post

Submit to CRAN:

  • usethis::use_version('major')
  • devtools::submit_cran()
  • Approve email

Wait for CRAN...

  • Accepted 🎉
  • git push
  • usethis::use_github_release()
  • usethis::use_dev_version()
  • git push
  • Finish blog post
  • Tweet
  • Add link to blog post in pkgdown news menu

Release TestPkg 0.0.0.9999

Prepare for release:

  • Submit PR to master branch
  • Merge PR via 'Rebase and merge'
  • Add next release version tag
  • Add release to public repo 🥳
  • 🎉

Update pkgdown websites for all somaverse

somaverse packages:

  • SomaReadr
  • SomaPlyr
  • SomaNormalization
  • SomaPipeline
  • SomaPlot
  • SomaGlobals
  • SomaClassify
  • SomaStabilitySelection
  • SomaSurvival
  • SomaPCA
  • SomaDB
  • somaverse
  • SomaMixedEffects
  • SomaFeatureSelect

SLIDE release checklist

Prepare for release

  • Check that all desired branches are merged
  • Run in SLIDE:
devtools::check(document = FALSE, 
                vignettes = FALSE,
                env_vars = c(ON_JENKINS = "true",
                             NOT_CRAN   = "true",
                             TZ         = "America/Denver"))
  • Run:
glog -10    # decide which semantic version to use

semantic version system

  • Run:
# choices are: 'major', 'minor', 'patch'
Rscript --vanilla -e "somaverse::init_release(ver = 'minor')"
  • Edit NEWS.md file
  • Run:
# ensure no spelling errors introduced in the NEWS.md
Rscript --vanilla -e "devtools::spell_check()"
  • Run
Rscript --vanilla -e "somaverse::push_release()"
  • Run
make pkgdown
  • Run
Rscript --vanilla -e "somaverse::bump_to_dev()"

Core Packages:

  • SomaReadr
  • SomaGlobals
  • SomaPlyr
  • SomaPlot
  • SomaClassify
  • SomaSurvival
  • palantir

Non-core:

  • SomaPCA
  • SomaNormalization
  • SomaStabilitySelection
  • SomaMixedEffects

Independent-pkgs:

  • SomaDB

AppMod-pkgs:

  • SomaPipeline
  • SomaModelAssessment
  • SomaModelChange
  • SMAdata

Meta-pkgs:

  • somaverse

Semi-stale-pkgs:

  • SomaFeatureSelect
  • SomaBiomarkers

Update DESCRIPTION with `use_tidy_description()`

SOMAVERSE-63
SomaPackages:

  • SomaReadr
  • SomaPlyr
  • SomaPlot
  • SomaGlobals
  • SomaClassify
  • SomaStabilitySelection
  • SomaSurvival
  • SomaPCA
  • SomaDB
  • SomaDataIO
  • SomaNormalization
  • somaverse
  • SomaMixedEffects
  • SomaFeatureSelect
  • SomaPipeline
  • SomaCluster
  • SomaBiomarkers
  • LeedsPredict

Release TestPkg 0.0.0.9005

Prepare for release:

  • Check that description is informative
  • Check licensing of included files
  • usethis::use_cran_comments()
  • devtools::check()
  • devtools::check_win_devel()
  • rhub::check_for_cran()
  • Polish pkgdown reference index
  • Draft blog post

Submit to CRAN:

  • usethis::use_version('major')
  • Update cran-comments.md
  • devtools::submit_cran()
  • Approve email

Wait for CRAN...

  • Accepted 🎉
  • usethis::use_github_release()
  • usethis::use_dev_version()
  • usethis::use_news_md()
  • Update install instructions in README
  • Finish blog post
  • Tweet
  • Add link to blog post in pkgdown news menu

Git Submodule Steps

  1. git checkout -b <name>
  2. cd SomaReadr
  3. git checkout <SHA> # the proposed commit
  4. cd ..
  5. git add SomaReadr
  6. git commit <give description of what/why you are doing>
  7. git push origin <name>
  8. Submit pull request

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.