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

Removed SeqRunName in all relevant places. #14

Merged
merged 3 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog


## [1.0.5] - 2024-10-09
- removed `SeqRunName` variable, as it is not needed by cellranger anymore

## [1.0.4] - 2023-09-19

### Changed
Expand Down
13 changes: 3 additions & 10 deletions config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,15 @@ A pre-configured samplemap ready to run on the test data that can be adapted is
Example samplemap:

```
sample HashingFile SeqRunName nTargetCells featureReferenceFile
sampleA HashingFileA SeqRunNameA 10000 featureReferenceFileA
sampleB HashingFileB SeqRunNameB 15000 featureReferenceFileB
sample HashingFile nTargetCells featureReferenceFile
sampleA HashingFileA 10000 featureReferenceFileA
sampleB HashingFileB 15000 featureReferenceFileB
```

With one line per set of samples

- `sample` contains the sample identifier that is used throughout the pipeline
- `HashingFile` contains the full path to the comma separated text file containing the hashtag barcodes and their assignment to individual sample names (see [HashingFile](#hashingfile)).
- `SeqRunName` corresponds to the sequencing sample name of the ADT sample; this parameter is only required for the Cellranger run of ADT data. It can be retrieved from the FASTQ file names as follows:

```
[SeqRunName]_S[Number]_L00[Lane Number]_[Read Type]_001.fastq.gz
```

Where Read Type is one of: I1, R1, R2.

- `nTargetCells` corresponds to the number of targeted cells for the sample.
- `featureReferenceFile` corresponds to the ADT feature reference file for the sample set. For further information please consult the Cellranger tool documentation.
Expand Down
4 changes: 2 additions & 2 deletions config/samplemap
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
sample HashingFile SeqRunName nTargetCells featureReferenceFile
PBMC_D1 testdata/HashingFile_PBMC_D1.csv BSSE_QGF_132646_HHVFNDRXX_1_PBMC_mix_20k_ADT_E3_SI-NA-E3 20000 testdata/feature_reference.txt
sample HashingFile nTargetCells featureReferenceFile
PBMC_D1 testdata/HashingFile_PBMC_D1.csv 20000 testdata/feature_reference.txt
1 change: 0 additions & 1 deletion workflow/rules/adt_cellranger.smk
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ rule create_library_file_adt:
library_file=WORKDIR
+ "/results/pooled_samples/cellranger_adt/{sample_set}.adt_library.txt",
params:
seqRunName=getSeqRunName,
threads: config["computingResources"]["threads"]["low"]
resources:
mem_mb=config["computingResources"]["mem_mb"]["low"],
Expand Down
11 changes: 0 additions & 11 deletions workflow/rules/misc_snake.smk
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,6 @@ def getTargetCellsCellranger_simple(wildcards):
return out


# Retrieve the ADT sequencing run name corresponding to a given sample set
def getSeqRunName(wildcards):
# Create dictionary with samples and SeqRunName
sampleMap = dict(zip(samples["sample"], samples["SeqRunName"]))
if wildcards.sample_set not in sampleMap.keys():
raise ValueError(
"Sample '%s' not found in the sample map!" % (wildcards.sample_set)
)
return sampleMap[wildcards.sample_set]


# Retrieve the ADT feature reference file corresponding to a given sample set
def getFeatRefFile(wildcards):
# Create dictionary with samples and FeatureRefFile
Expand Down
4 changes: 0 additions & 4 deletions workflow/schema/sample_map.schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ properties:
HashingFile:
type: string
description: Path to the Tag File
SeqRunName:
type: string
description: Sequencing sample name of ADT Fastq Files
nTargetCells:
type: integer
description: The number of cells that were targeted in the lab
Expand All @@ -20,7 +17,6 @@ properties:
required:
- sample
- HashingFile
- SeqRunName
- nTargetCells
- featureReferenceFile

Loading