Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initiate ropenspca package #735

Conversation

sjspielman
Copy link
Member

Closes #732

This PR initiates the directory for the rOpenScPCA package. Some notes:

  • I've also added a workflow to R CMD CHECK the package, and a temporary function to test as part of that to make sure it works.
  • I was on the fence for whether or not we should use renv to track packages used during package development. For now, I've included renv, but I'm not really tied to keeping it. What do you think?
  • In DESCRIPTION how's my syntax for referencing the repo's top-level LICENSE file? Surprising nobody, devtools::check() gives it a WARNING, but could be ok for this circumstance?

@sjspielman
Copy link
Member Author

If rcmdcheck is loading up the renv environment, that would explain the CI failure as indeed rcmdcheck isn't in renv.lock...

@jashapiro
Copy link
Member

I think I would start this without renv as that adds some unnecessary complexity.

Comment on lines 29 to 30
with:
extra-packages: |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to specify the directory here. (And you should not need to specify testthat as that is part of the DESCRIPTION)

Suggested change
with:
extra-packages: |
with:
working-directory: "packages/rOpenScPCA/"
extra-packages: |

Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall, but we do want it to pass all the checks.

Maintainer: Stephanie J. Spielman <[email protected]>
Description: This package contains utility functions that support single-cell RNA-seq
analysis in R-based OpenScPCA analysis module code.
License: BSD_3_clause + ../../LICENSE file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The syntax is + file LICENSE so that could be part of the error, but the location seems like a likely culprit as well.

To quiet this error, I would probably just copy the license file into the package.

We'll probably end up wanting to skip some other checks too (we don't need strict CRAN compliance), but we can cross that bridge later.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To quiet this error, I would probably just copy the license file into the package.

👍

packages/rOpenScPCA/DESCRIPTION Outdated Show resolved Hide resolved
Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sjspielman sjspielman merged commit 3bc8772 into AlexsLemonade:feature/ropenscpca Aug 30, 2024
5 checks passed
@sjspielman sjspielman deleted the sjspielman/732-initiate-rOpenScPCA branch August 30, 2024 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants