{"id":14067958,"url":"https://github.com/ropensci-archive/tic.package","last_synced_at":"2025-07-30T02:32:30.128Z","repository":{"id":56211414,"uuid":"94645518","full_name":"ropensci-archive/tic.package","owner":"ropensci-archive","description":":no_entry: ARCHIVED :no_entry: Example Package for 'tic'","archived":true,"fork":false,"pushed_at":"2022-05-10T14:01:12.000Z","size":590,"stargazers_count":9,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-13T07:14:04.067Z","etag":null,"topics":["r","r-package","rstats","tic"],"latest_commit_sha":null,"homepage":"https://ropenscilabs.github.io/tic.package/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ropensci-archive.png","metadata":{"files":{"readme":"README-NOT.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-17T19:45:29.000Z","updated_at":"2023-01-28T00:55:37.000Z","dependencies_parsed_at":"2022-08-15T14:50:09.437Z","dependency_job_id":null,"html_url":"https://github.com/ropensci-archive/tic.package","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Ftic.package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Ftic.package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Ftic.package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Ftic.package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ropensci-archive","download_url":"https://codeload.github.com/ropensci-archive/tic.package/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228075663,"owners_count":17865515,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["r","r-package","rstats","tic"],"created_at":"2024-08-13T07:05:51.934Z","updated_at":"2024-12-04T08:31:23.782Z","avatar_url":"https://github.com/ropensci-archive.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"# tic.package\n\n\u003c!-- badges: start --\u003e\n[![R CMD Check via {tic}](https://img.shields.io/github/workflow/status/ropenscilabs/tic.package/R%20CMD%20Check%20via%20%7Btic%7D?logo=github\u0026label=R%20CMD%20Check%20via%20{tic}\u0026style=flat-square)](https://github.com/ropenscilabs/tic.package/actions)\n[![Travis build status](https://img.shields.io/travis/ropenscilabs/tic.package/master?logo=travis\u0026style=flat-square\u0026label=Linux)](https://travis-ci.com/ropenscilabs/tic.package)\n[![CircleCI build status](https://img.shields.io/circleci/build/gh/ropenscilabs/tic.package/master?label=Linux\u0026logo=circle\u0026logoColor=green\u0026style=flat-square)](https://circleci.com/gh/ropenscilabs/tic.package)\n[![AppVeyor build status](https://img.shields.io/appveyor/ci/ropenscilabs/tic-package?label=Windows\u0026logo=appveyor\u0026style=flat-square)](https://ci.appveyor.com/project/ropenscilabs/tic-package)\n\u003c!-- badges: end --\u003e\n\nA minimal example package with _pkgdown_ documentation created and uploaded by [_tic_](https://github.com/ropenscilabs/tic) (the _pkgdown_ documentation is written to, and served from, the `docs` directory of the `master` branch.).\n_tic_ is an R package for CI-agnostic workflow definitions for various R projects. \nSee its [documentation](https://ropenscilabs.github.io/tic/) for more information.\n\n## Set up an operational fork of this repository\n\nIf you want to experiment with _travis_ and _tic_ for a R package, you can fork it.\n\n1. Use `usethis::create_from_github()` to automatically create a fork of this repo.\n    If you use RStudio, a new RStudio project will open. \n    You may need to set up your SSH credentials first. \n    See [this guide](http://happygitwithr.com/ssh-keys.html) if you're having problems. \n    (It's definitely worth getting this function running as it saves you a lot of time in the future!) \n    Alternatively, fork this repo on Github and then create a new R Project within RStudio (File -\u003e New Project -\u003e Version Control -\u003e Github). \n1. Run `tic::use_tic()` to set up all requirements needed for the CI integration of your package.\n\n## Create a package from scratch\n\nThis is the detailed way going step by step from the bottom up.\nLooking here can be useful if you already have an R package and just want to add some functionality to it, e.g. using _roxygen2_ with Markdown (item 3) or enabling CI for your package (item 6).\n\n1. Use `usethis::create_package(\"\u003cpath-to-package-dir\u003e\")`. \n    Here is an example with a package called `tic.package` stored within the `~/git/` directory:\n    \n    ```r\n    usethis::create_package(\"~/git/tic.package\")\n    ✔ Changing active project to '/home/\u003cusername\u003e/git/tic.package'\n    ✔ Creating 'R/'\n    ✔ Creating 'man/'\n    ✔ Writing 'DESCRIPTION'\n    ✔ Writing 'NAMESPACE'\n    ✔ Writing 'tic.package.Rproj'\n    ✔ Adding '.Rproj.user' to '.gitignore'\n    ✔ Adding '^tic.package\\\\.Rproj$', '^\\\\.Rproj\\\\.user$' to '.Rbuildignore'\n    ✔ Opening new project 'tic.package' in RStudio\n    ```\n\n2. Initialize Git via `usethis::use_git()`:\n\n    ```\n    ✔ Changing active project to '/home/\u003cusername\u003e/git/tic.package'\n    ✔ Initialising Git repo\n    ✔ Adding '.Rhistory', '.RData' to '.gitignore'\n    OK to make an initial commit of 5 files?\n    1: Yup\n    2: No\n    3: Absolutely not\n\n    Selection: 1\n    ✔ Adding files and committing\n    ● A restart of RStudio is required to activate the Git pane\n    ● Restart now?\n    1: Absolutely\n    2: No way\n    3: Absolutely not\n\n    Selection: 1\n    ```\n\n3. (Optional) Use _roxygen2_ with Markdown support for package documentation: `usethis::use_roxygen_md()`:\n\n    ```r\n    ✔ Changing active project to '/home/\u003cusername\u003e/git/tic.package'\n    ✔ Setting Roxygen field in DESCRIPTION to 'list(markdown = TRUE)'\n    ✔ Setting RoxygenNote field in DESCRIPTION to '6.0.1.9000'\n    ● Run `devtools::document()`\n    ```\n\n4. Add a license: `usethis::add_gpl3_license()` (or any license of your choice):\n\n     ```r\n    ✔ Changing active project to '/home/\u003cusername\u003e/git/tic.package'\n    ✔ Setting License field in DESCRIPTION to 'GPL-3'\n    ✔ Writing 'LICENSE.md'\n    ✔ Adding '^LICENSE\\\\.md$' to '.Rbuildignore'\n    ```\n\n5. Create a Github repo by using `usethis::use_github()`:\n\n    ```r\n    ● Check title and description\n      Name:        tic.package\n      Description: What the Package Does (One Line, Title Case)\n    Are title and description ok?\n    1: No way\n    2: I agree\n    3: Nope\n\n    Selection: 2\n    ✔ Creating GitHub repository\n    ✔ Adding GitHub remote\n    ✔ Adding GitHub links to DESCRIPTION\n    ✔ Setting URL field in DESCRIPTION to 'https://github.com/\u003cuser\u003e/tic.package'\n    ✔ Setting BugReports field in DESCRIPTION to 'https://github.com/\u003cuser\u003e/tic.package/issues'\n    ✔ Pushing to GitHub and setting remote tracking branch\n    ```\n\n6. Set up Continuous Integration by using `tic::use_tic()`. Take a look at the [Getting Started](https://ropenscilabs.github.io/tic/articles/tic.html) vignette of the [tic](https://github.com/ropenscilabs/tic) package for a detailed walkthrough.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci-archive%2Ftic.package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fropensci-archive%2Ftic.package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci-archive%2Ftic.package/lists"}