diff --git a/.Rbuildignore b/.Rbuildignore index 4e7d271..08a1cea 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -11,3 +11,4 @@ ^codecov\.yml$ ^data-raw$ ^\.lintr$ +^CODE_OF_CONDUCT\.md$ diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index 652d936..64249c4 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -6,7 +6,7 @@ on: pull_request: branches: [main, master] -name: R-CMD-check +name: R-CMD-check.yaml permissions: read-all diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index c9f0165..4bbce75 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -9,7 +9,7 @@ on: types: [published] workflow_dispatch: -name: pkgdown +name: pkgdown.yaml permissions: read-all diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml index f450c29..6882241 100644 --- a/.github/workflows/test-coverage.yaml +++ b/.github/workflows/test-coverage.yaml @@ -6,7 +6,7 @@ on: pull_request: branches: [main, master] -name: test-coverage +name: test-coverage.yaml permissions: read-all diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0f12e62 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,126 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at psychelzh@outlook.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion]. + +For answers to common questions about this code of conduct, see the FAQ at +. Translations are available at . + +[homepage]: https://www.contributor-covenant.org diff --git a/DESCRIPTION b/DESCRIPTION index 6c89f9b..38f597c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: tarflow.iquizoo Title: Setup "targets" Workflows for "iquizoo" Data Processing -Version: 3.12.3 +Version: 3.12.3.9000 Authors@R: c( person("Liang", "Zhang", , "psychelzh@outlook.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-9041-1150")), diff --git a/NEWS.md b/NEWS.md index 24a2c24..a65f590 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,5 @@ +# tarflow.iquizoo (development version) + # tarflow.iquizoo 3.12.3 ## Upkeep diff --git a/R/tarflow.iquizoo-package.R b/R/tarflow.iquizoo-package.R new file mode 100644 index 0000000..d248733 --- /dev/null +++ b/R/tarflow.iquizoo-package.R @@ -0,0 +1,7 @@ +#' @keywords internal +"_PACKAGE" + +## usethis namespace: start +#' @import rlang +## usethis namespace: end +NULL diff --git a/R/zzz.R b/R/zzz.R index cf57234..831766f 100644 --- a/R/zzz.R +++ b/R/zzz.R @@ -1,6 +1,3 @@ -#' @import rlang -NULL - # nocov start .onLoad <- function(libname, pkgname) { diff --git a/README.Rmd b/README.Rmd index 54e31af..a411919 100644 --- a/README.Rmd +++ b/README.Rmd @@ -19,7 +19,7 @@ knitr::opts_chunk$set( [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![tarflow.iquizoo status badge](https://psychelzh.r-universe.dev/badges/tarflow.iquizoo)](https://psychelzh.r-universe.dev/tarflow.iquizoo) [![R-CMD-check](https://github.com/psychelzh/tarflow.iquizoo/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/psychelzh/tarflow.iquizoo/actions/workflows/R-CMD-check.yaml) -[![Codecov test coverage](https://codecov.io/gh/psychelzh/tarflow.iquizoo/branch/main/graph/badge.svg)](https://app.codecov.io/gh/psychelzh/tarflow.iquizoo?branch=main) +[![Codecov test coverage](https://codecov.io/gh/psychelzh/tarflow.iquizoo/graph/badge.svg)](https://app.codecov.io/gh/psychelzh/tarflow.iquizoo) The goal of tarflow.iquizoo is to provide workflow auto-generation for IQUIZOO data powered by [targets](https://github.com/ropensci/targets) package. @@ -46,3 +46,7 @@ install.packages("tarflow.iquizoo", repos = c(getOption("repos"), "https://psych ## Usage This simplest way to use this package is to call `tarflow.iquizoo::use_targets_pipeline()` to generate a {[targets](https://docs.ropensci.org/targets/)} pipeline. After some basic parameters edit (follow the generated script), then you can run the pipeline by executing `targets::tar_make()` in R console. The pipeline will be executed in parallel by default. + +## Code of Conduct + +Please note that the tarflow.iquizoo project is released with a [Contributor Code of Conduct](https://psychelzh.github.io/tarflow.iquizoo/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms diff --git a/README.md b/README.md index dc34e53..2c08c93 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https:// badge](https://psychelzh.r-universe.dev/badges/tarflow.iquizoo)](https://psychelzh.r-universe.dev/tarflow.iquizoo) [![R-CMD-check](https://github.com/psychelzh/tarflow.iquizoo/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/psychelzh/tarflow.iquizoo/actions/workflows/R-CMD-check.yaml) [![Codecov test -coverage](https://codecov.io/gh/psychelzh/tarflow.iquizoo/branch/main/graph/badge.svg)](https://app.codecov.io/gh/psychelzh/tarflow.iquizoo?branch=main) +coverage](https://codecov.io/gh/psychelzh/tarflow.iquizoo/graph/badge.svg)](https://app.codecov.io/gh/psychelzh/tarflow.iquizoo) The goal of tarflow.iquizoo is to provide workflow auto-generation for @@ -56,3 +56,10 @@ This simplest way to use this package is to call basic parameters edit (follow the generated script), then you can run the pipeline by executing `targets::tar_make()` in R console. The pipeline will be executed in parallel by default. + +## Code of Conduct + +Please note that the tarflow.iquizoo project is released with a +[Contributor Code of +Conduct](https://psychelzh.github.io/tarflow.iquizoo/CODE_OF_CONDUCT.html). +By contributing to this project, you agree to abide by its terms diff --git a/man/tarflow.iquizoo-package.Rd b/man/tarflow.iquizoo-package.Rd new file mode 100644 index 0000000..6605b17 --- /dev/null +++ b/man/tarflow.iquizoo-package.Rd @@ -0,0 +1,29 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/tarflow.iquizoo-package.R +\docType{package} +\name{tarflow.iquizoo-package} +\alias{tarflow.iquizoo} +\alias{tarflow.iquizoo-package} +\title{tarflow.iquizoo: Setup "targets" Workflows for "iquizoo" Data Processing} +\description{ +For "iquizoo" data processing, there is already a package called "preproc.iquizoo", but eventually the use of it is relied on a workflow. This package is used to build such workflows based on tools provided by "targets" package which mimics the logic of "make", automating the building processes. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://psychelzh.github.io/tarflow.iquizoo/} + \item \url{https://github.com/psychelzh/tarflow.iquizoo} + \item Report bugs at \url{https://github.com/psychelzh/tarflow.iquizoo/issues} +} + +} +\author{ +\strong{Maintainer}: Liang Zhang \email{psychelzh@outlook.com} (\href{https://orcid.org/0000-0001-9041-1150}{ORCID}) + +Other contributors: +\itemize{ + \item Yujian Dai [contributor] +} + +} +\keyword{internal}