Uh oh!
There was an error while loading. Please reload this page.
Enhance STlist documentation and replace regex for sample name checks - #20
Open
kweav wants to merge 1 commit into
Open
Enhance STlist documentation and replace regex for sample name checks#20kweav wants to merge 1 commit into
kweav wants to merge 1 commit into
Conversation
Updated documentation for STlist function and improved sample name validation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated documentation for STlist function and improved sample name validation.
When working with the
STlistfunction for reading in a list of dataframes, I hadn't noticed the requirement to have gene names in the first column for my RNA counts data. So my suggested change adds the note about that requirement from a previous part of the documentation (file paths) to the part of the documentation about lists of data frames.Also, when providing data where I had formatted my sample IDs in way that matched the stated requirements, I was receiving an error code saying my data didn't follow the allowed pattern. However I was using
Br####-DXwhich followed all of the stated requirements (not beginning with a number but rather a letter, and only having alphanumeric characters, spaces, dashes, or underscores). So I'm suggesting a different regex pattern and have simplified it to only conduct one test rather than two separate ones.My suggested regex pattern looks for a letter at the beginning (denoted by the caret) and then alpha-numeric, space, dash, or underscore after throughout to the end of the string (denoted by the dollar sign)
I've tested the regex pattern change with several examples, and the test now works as expected. I have not tested if this change has any downstream implications for the spatialGE package.