package

:package: The Title of the Project

https://github.com/brainworkup/package

Science Score: 31.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.1%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

:package: The Title of the Project

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme Contributing License Code of conduct Citation Codemeta

README.Rmd

---
output: github_document
---




```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/",
  out.width = "100%"
)
```



package 
=========================================================


[![CRAN status](https://www.r-pkg.org/badges/version/package)](https://CRAN.R-project.org/package=package)
[![R CMD Check](https://github.com/brainworkup/package/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/brainworkup/package/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/brainworkup/package/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/brainworkup/package/actions/workflows/pkgdown.yaml)
[![Test coverage](https://github.com/brainworkup/package/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/brainworkup/package/actions/workflows/test-coverage.yaml)
[![codecov](https://codecov.io/gh/brainworkup/package/branch/main/graph/badge.svg)](https://codecov.io/gh/brainworkup/package)
[![License: GPL (>= 2)](https://img.shields.io/badge/License-GPL%20%28%3E%3D%202%29-blue.svg)](https://choosealicense.com/licenses/gpl-2.0/)




Overview
Features
Installation
Get started
Long-form documentations
Citation
Contributing
Acknowledgments
References

## Overview The R package `package`... **{{ is a template to create a structured R package. }}** ## Features The main purpose of `package` is to... **{{ DESCRIBE THE MAIN FEATURES }}** ## Installation You can install the development version from [GitHub](https://github.com/) with: ```{r eval=FALSE} ## Install < remotes > package (if not already installed) ---- if (!requireNamespace("pak", quietly = TRUE)) { install.packages("pak") } ## Install < package > from GitHub ---- pak::pak("brainworkup/package") ``` Then you can attach the package `package`: ```{r eval=FALSE} library("package") ``` ## Get started For an overview of the main features of `package`, please read the [Get started](https://brainworkup.github.io/package/articles/package.html) vignette. ## Long-form documentations `package` provides **{{ NUMBER OF VIGNETTES }}** vignettes to learn more about the package: - the [Get started](https://brainworkup.github.io/package/articles/package.html) vignette describes the core features of the package - **{{ LIST ADDITIONAL VIGNETTES }}** ## Citation Please cite `package` as: > Trampush Joey (`r format(Sys.Date(), "%Y")`) package: An R package to **{{ TITLE }}**. R package version 0.0.0.9000. ## Contributing All types of contributions are encouraged and valued. For more information, check out our [Contributor Guidelines](https://github.com/brainworkup/package/blob/main/CONTRIBUTING.md). Please note that the `package` project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms. ## Acknowledgments **{{ OPTIONAL SECTION }}** ## References **{{ OPTIONAL SECTION }}**

Owner

  • Name: Joey Trampush
  • Login: brainworkup
  • Kind: user
  • Location: Los Angeles
  • Company: University of Southern California (USC)

Assistant Professor of Psychiatry & Behavioral Sciences @ USC

Citation (CITATION.cff)

# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "package" in publications use:'
type: software
license: GPL-2.0-or-later
title: 'package: The Title of the Project'
version: 0.0.0.9000
abstract: A paragraph providing a full description of the project (on several lines...)
authors:
- family-names: Trampush
  given-names: Joey
  email: j.trampush@gmail.com
  orcid: https://orcid.org/0000-0003-0830-508X
preferred-citation:
  type: manual
  title: 'package: An R package to ...'
  authors:
  - name: Trampush Joey
  year: '2025'
  notes: R package version 0.0.0.9000
  url: https://github.com/brainworkup/package
repository-code: https://github.com/brainworkup/package
url: https://github.com/brainworkup/package
contact:
- family-names: Trampush
  given-names: Joey
  email: j.trampush@gmail.com
  orcid: https://orcid.org/0000-0003-0830-508X
references:
- type: software
  title: knitr
  abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
  notes: Suggests
  url: https://yihui.org/knitr/
  repository: https://CRAN.R-project.org/package=knitr
  authors:
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  year: '2025'
  doi: 10.32614/CRAN.package.knitr
- type: software
  title: rmarkdown
  abstract: 'rmarkdown: Dynamic Documents for R'
  notes: Suggests
  url: https://pkgs.rstudio.com/rmarkdown/
  repository: https://rstudio.r-universe.dev
  authors:
  - family-names: Allaire
    given-names: JJ
    email: jj@posit.co
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  - family-names: Dervieux
    given-names: Christophe
    email: cderv@posit.co
    orcid: https://orcid.org/0000-0003-4474-2498
  - family-names: McPherson
    given-names: Jonathan
    email: jonathan@posit.co
  - family-names: Luraschi
    given-names: Javier
  - family-names: Ushey
    given-names: Kevin
    email: kevin@posit.co
  - family-names: Atkins
    given-names: Aron
    email: aron@posit.co
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  - family-names: Cheng
    given-names: Joe
    email: joe@posit.co
  - family-names: Chang
    given-names: Winston
    email: winston@posit.co
  - family-names: Iannone
    given-names: Richard
    email: rich@posit.co
    orcid: https://orcid.org/0000-0003-3925-190X
  year: '2025'
  doi: 10.32614/CRAN.package.rmarkdown
- type: software
  title: testthat
  abstract: 'testthat: Unit Testing for R'
  notes: Suggests
  url: https://testthat.r-lib.org
  repository: https://CRAN.R-project.org/package=testthat
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2025'
  doi: 10.32614/CRAN.package.testthat
  version: '>= 3.0.0'

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "package",
  "description": "A paragraph providing a full description of the project (on several lines...)",
  "name": "package: The Title of the Project",
  "codeRepository": "https://github.com/brainworkup/package",
  "issueTracker": "https://github.com/brainworkup/package/issues",
  "license": "https://spdx.org/licenses/GPL-2.0",
  "version": "0.0.0.9000",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.3 Patched (2025-02-28 r87984)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Joey",
      "familyName": "Trampush",
      "email": "j.trampush@gmail.com",
      "@id": "https://orcid.org/0000-0003-0830-508X"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Joey",
      "familyName": "Trampush",
      "email": "j.trampush@gmail.com",
      "@id": "https://orcid.org/0000-0003-0830-508X"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Joey",
      "familyName": "Trampush",
      "email": "j.trampush@gmail.com",
      "@id": "https://orcid.org/0000-0003-0830-508X"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "SystemRequirements": null
  },
  "fileSize": "229776.742KB",
  "citation": [
    {
      "@type": "SoftwareSourceCode",
      "datePublished": "2025",
      "author": [
        {
          "@type": "Organization",
          "name": "Trampush Joey"
        }
      ],
      "name": "package: {An} {R} package to ...",
      "url": "https://github.com/brainworkup/package",
      "description": "R package version 0.0.0.9000"
    }
  ],
  "readme": "https://github.com/brainworkup/package/blob/main/README.md"
}

GitHub Events

Total
  • Watch event: 1
  • Push event: 7
  • Create event: 3
Last Year
  • Watch event: 1
  • Push event: 7
  • Create event: 3

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/render-README.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/update-citation-cff.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/update-codemeta.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests