Skip to content

Commit bc7dac9

Browse files
ArvindiyerArvindiyer
authored
Merge pull request #5 from CSOgroup/dev
Refactoring and cran prep v0.1.6
2 parents b380ebd + 0e6cb92 commit bc7dac9

390 files changed

Lines changed: 524818 additions & 3147 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.Rbuildignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,9 @@
44
^docs$
55
^pkgdown$
66
^\.github$
7+
^INSTALLATION\.md$
8+
^environment\.yml$
9+
^CONTRIBUTING\.md$
10+
^CODE_OF_CONDUCT\.md$
11+
^dev$
12+
^cran-comments\.md$

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug report
3+
about: Report a bug or unexpected behaviour in SelectSim
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Describe the bug
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Minimal reproducible example
14+
15+
```r
16+
library(SelectSim)
17+
# paste the smallest code that reproduces the issue
18+
```
19+
20+
## Expected behaviour
21+
22+
What you expected to happen.
23+
24+
## Actual behaviour
25+
26+
What actually happened. Include the full error message or unexpected output.
27+
28+
## Environment
29+
30+
- SelectSim version: <!-- packageVersion("SelectSim") -->
31+
- R version: <!-- R.version.string -->
32+
- OS: <!-- e.g. macOS 14.5, Ubuntu 22.04 -->
33+
- Installation method: <!-- devtools::install_github / local build -->
34+
35+
## Additional context
36+
37+
Any other context that may be relevant (e.g. dataset size, number of cores used).

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or improvement for SelectSim
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Is your feature request related to a problem?
10+
11+
A clear and concise description of the problem or limitation you are experiencing.
12+
13+
## Proposed solution
14+
15+
Describe the feature or change you would like to see, including any API design ideas if relevant.
16+
17+
## Alternatives considered
18+
19+
Any alternative approaches you have considered, and why you prefer the proposed solution.
20+
21+
## Additional context
22+
23+
Any other context, references, or examples that support the request.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Summary
2+
3+
<!-- What does this PR do? Reference any related issues with "Fixes #N" or "Closes #N". -->
4+
5+
## Changes
6+
7+
-
8+
9+
## Test plan
10+
11+
- [ ] `devtools::document()` run to regenerate NAMESPACE / man pages
12+
- [ ] `devtools::check()` passes with 0 errors, 0 warnings, 0 notes
13+
- [ ] New or changed behaviour covered by tests in `tests/testthat/`
14+
- [ ] Documentation updated (roxygen tags, vignette, README) if applicable

‎.github/workflows/R-CMD-check.yaml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
on:
2+
push:
3+
branches: [main]
4+
pull_request:
5+
branches: [main]
6+
7+
name: R-CMD-check
8+
9+
jobs:
10+
R-CMD-check:
11+
runs-on: ${{ matrix.config.os }}
12+
13+
name: ${{ matrix.config.os }} (R ${{ matrix.config.r }})
14+
15+
strategy:
16+
fail-fast: false
17+
matrix:
18+
config:
19+
- {os: macos-latest, r: 'release'}
20+
- {os: windows-latest, r: 'release'}
21+
- {os: ubuntu-latest, r: 'release'}
22+
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
23+
24+
env:
25+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
26+
R_KEEP_PKG_SOURCE: yes
27+
28+
steps:
29+
- uses: actions/checkout@v4
30+
31+
- uses: r-lib/actions/setup-pandoc@v2
32+
33+
- uses: r-lib/actions/setup-r@v2
34+
with:
35+
r-version: ${{ matrix.config.r }}
36+
http-user-agent: ${{ matrix.config.http-user-agent }}
37+
use-public-rspm: true
38+
39+
- uses: r-lib/actions/setup-r-dependencies@v2
40+
with:
41+
extra-packages: any::rcmdcheck
42+
needs: check
43+
44+
- uses: r-lib/actions/check-r-package@v2
45+
with:
46+
upload-snapshots: true
47+
build_args: 'c("--no-manual", "--compact-vignettes=gs+qpdf")'

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@
77
.ipynb_checkpoints
88
inst/doc
99
.*
10-
!/.gitignore
10+
!/.gitignore
11+
!/.github

‎CODE_OF_CONDUCT.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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, colour, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behaviour that contributes to a positive environment:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologising to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behaviour:
20+
21+
- The use of sexualised language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behaviour and will take appropriate and fair corrective action in response to any behaviour that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to the community leaders responsible for enforcement at giovanni.ciriello@unil.ch. All complaints will be reviewed and investigated promptly and fairly.
38+
39+
## Attribution
40+
41+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

‎CONTRIBUTING.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing to SelectSim
2+
3+
Thank you for your interest in contributing to SelectSim. This document explains how to report bugs, suggest features, and submit code.
4+
5+
## Reporting bugs
6+
7+
Please use the [issue tracker](https://github.com/CSOgroup/SelectSim/issues) and select the **Bug report** template. Include:
8+
9+
- SelectSim version (`packageVersion("SelectSim")`)
10+
- R version and OS
11+
- A minimal reproducible example (preferably using the bundled `luad_run_data`)
12+
- The full error message or unexpected output
13+
14+
## Suggesting features
15+
16+
Open an issue using the **Feature request** template. Describe the use case and why it would benefit users of the package.
17+
18+
## Contributing code
19+
20+
1. Fork the repository and create a branch from `main`.
21+
2. Follow the existing code style (base R where possible; tidyverse only via already-imported packages).
22+
3. Add or update tests in `tests/testthat/` for any new or changed behaviour.
23+
4. Run `devtools::check()` and ensure 0 errors, 0 warnings, and 0 notes before opening a pull request.
24+
5. Update roxygen2 documentation (`devtools::document()`) if you change function signatures or add new functions.
25+
6. Open a pull request against `main` using the provided PR template.
26+
27+
## Code of conduct
28+
29+
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating you agree to abide by its terms.
30+
31+
## Questions
32+
33+
For questions about the SelectSim methodology, contact Giovanni Ciriello (giovanni.ciriello@unil.ch) or Arvind Iyer (ayalurarvind@gmail.com).

‎DESCRIPTION‎

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
Package: SelectSim
2-
Title: Selected Events Linked by Evolutionary Conditions across human Tumors
3-
Version: 0.0.1.5
4-
Authors@R:
5-
c(person("Arvind", "Iyer", , "ayalurarvind@gamil.com", role = c("aut", "cre"),comment = c(ORCID = "0000-0002-8247-700X")),
6-
person("Marco", "Mina", , "marco.mina.85@gmail.com", role = c("aut")),
7-
person("Miljan", "Petrovic", , "miljanpet93@gmail.com", role = c("aut")),
8-
person("Giovanni", "Ciriello", , "givoanni.cirello@unil.ch", role = c("aut"),comment = c(ORCID ="0000-0003-2021-8683")))
9-
Description: This R package implements the SelectSim methodology to infer co-mutations between functional alterations in cancer.
2+
Title: Selected Events Linked by Evolutionary Conditions Across Human Tumors
3+
Version: 0.1.6
4+
Authors@R: c(
5+
person("Arvind", "Iyer", , "ayalurarvind@gmail.com", role = c("aut", "cre"),
6+
comment = c(ORCID = "0000-0002-8247-700X")),
7+
person("Marco", "Mina", , "marco.mina.85@gmail.com", role = "aut"),
8+
person("Miljan", "Petrovic", , "miljanpet93@gmail.com", role = "aut"),
9+
person("Giovanni", "Ciriello", , "giovanni.ciriello@unil.ch", role = "aut",
10+
comment = c(ORCID = "0000-0003-2021-8683"))
11+
)
12+
Description: This R package implements the SelectSim methodology to infer
13+
co-mutations between functional alterations in cancer.
1014
License: MIT + file LICENSE
11-
Encoding: UTF-8
12-
Roxygen: list(markdown = TRUE)
13-
RoxygenNote: 7.3.2
14-
Imports:
15+
URL: https://csogroup.github.io/SelectSim/
16+
BugReports: https://github.com/CSOgroup/SelectSim/issues
17+
Depends:
18+
R (>= 3.5)
19+
Imports:
1520
doParallel,
1621
doRNG,
1722
dplyr,
@@ -20,20 +25,24 @@ Imports:
2025
ggpubr,
2126
ggridges,
2227
Matrix,
28+
parallel,
2329
Rcpp,
24-
reshape2,
2530
Rfast,
26-
tictoc
27-
Suggests:
31+
stats
32+
Suggests:
2833
knitr,
2934
rmarkdown,
30-
testthat (>= 3.0.0)
31-
Config/testthat/edition: 3
32-
Depends:
33-
R (>= 3.5)
34-
LazyData: true
35-
VignetteBuilder: knitr
36-
URL: https://csogroup.github.io/SelectSim/
37-
LinkingTo:
35+
testthat (>= 3.0.0),
36+
tictoc
37+
LinkingTo:
3838
Rcpp,
3939
RcppArmadillo
40+
VignetteBuilder:
41+
knitr
42+
Config/testthat/edition: 3
43+
Encoding: UTF-8
44+
LazyData: true
45+
LazyDataCompression: xz
46+
Roxygen: list(markdown = TRUE)
47+
RoxygenNote: 8.0.0
48+
Language: en-US

‎NAMESPACE‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export(selectX)
4646
export(stat_maf_column)
4747
export(stat_maf_gene)
4848
export(stat_maf_sample)
49-
export(templeate.obj.gen)
49+
export(template.obj.gen)
5050
export(theme_Publication)
5151
export(w.r.am.pairwise.alteration.overlap)
5252
import(doParallel)
@@ -55,8 +55,6 @@ import(foreach)
5555
import(ggplot2)
5656
import(ggpubr)
5757
import(ggridges)
58-
import(graphics)
59-
import(parallel)
6058
importFrom(Matrix,Matrix)
6159
importFrom(Matrix,sparseMatrix)
6260
importFrom(Matrix,t)
@@ -65,20 +63,19 @@ importFrom(Rfast,rowSort)
6563
importFrom(dplyr,"%>%")
6664
importFrom(dplyr,arrange)
6765
importFrom(dplyr,case_when)
66+
importFrom(dplyr,distinct)
6867
importFrom(dplyr,filter)
6968
importFrom(dplyr,group_by)
7069
importFrom(dplyr,left_join)
7170
importFrom(dplyr,mutate)
7271
importFrom(dplyr,row_number)
7372
importFrom(dplyr,ungroup)
74-
importFrom(reshape2,acast)
75-
importFrom(reshape2,melt)
73+
importFrom(parallel,makeCluster)
74+
importFrom(parallel,stopCluster)
7675
importFrom(stats,as.dist)
7776
importFrom(stats,density)
7877
importFrom(stats,ecdf)
7978
importFrom(stats,median)
8079
importFrom(stats,runif)
8180
importFrom(stats,setNames)
82-
importFrom(tictoc,tic)
83-
importFrom(tictoc,toc)
8481
useDynLib(SelectSim, .registration = TRUE)

0 commit comments

Comments
 (0)