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

names() does not include the description #273

Open
SamGG opened this issue Jan 20, 2025 · 2 comments
Open

names() does not include the description #273

SamGG opened this issue Jan 20, 2025 · 2 comments

Comments

@SamGG
Copy link
Contributor

SamGG commented Jan 20, 2025

Hi guys,
I noticed that the documentation of the names() function/method does not match its result as the description is not included.
Best,
Samuel

library(flowCore)
data("GvHD")
# names Extract pretty formated names of the parameters including parameter descriptions.
names(GvHD[[1]])
#> [1] "<FSC-H> FSC-H" "<SSC-H> SSC-H" "<FL1-H> FL1-H" "<FL2-H> FL2-H"
#> [5] "<FL3-H> FL3-H" "<FL2-A> FL2-A" "<FL4-H> FL4-H" "<Time> Time"
pData(parameters(GvHD[[1]]))
#>      name              desc range minRange maxRange
#> $P1 FSC-H        FSC-Height  1024        0     1023
#> $P2 SSC-H        SSC-Height  1024        0     1023
#> $P3 FL1-H         CD15 FITC  1024        1    10000
#> $P4 FL2-H           CD45 PE  1024        1    10000
#> $P5 FL3-H        CD14 PerCP  1024        1    10000
#> $P6 FL2-A              <NA>  1024        0     1023
#> $P7 FL4-H          CD33 APC  1024        1    10000
#> $P8  Time Time (51.20 sec.)  1024        0     1023
sessionInfo()
#> R version 4.4.2 (2024-10-31 ucrt)
#> Platform: x86_64-w64-mingw32/x64
#> Running under: Windows 11 x64 (build 22631)
#> 
#> Matrix products: default
#> 
#> 
#> locale:
#> [1] LC_COLLATE=French_France.utf8  LC_CTYPE=French_France.utf8   
#> [3] LC_MONETARY=French_France.utf8 LC_NUMERIC=C                  
#> [5] LC_TIME=French_France.utf8    
#> 
#> time zone: Europe/Paris
#> tzcode source: internal
#> 
#> attached base packages:
#> [1] stats     graphics  grDevices utils     datasets  methods   base     
#> 
#> other attached packages:
#> [1] flowCore_2.18.0
#> 
#> loaded via a namespace (and not attached):
#>  [1] digest_0.6.37       fastmap_1.2.0       xfun_0.50          
#>  [4] matrixStats_1.5.0   glue_1.8.0          RProtoBufLib_2.18.0
#>  [7] cytolib_2.18.1      knitr_1.49          BiocGenerics_0.52.0
#> [10] Biobase_2.66.0      htmltools_0.5.8.1   rmarkdown_2.29     
#> [13] stats4_4.4.2        lifecycle_1.0.4     cli_3.6.3          
#> [16] reprex_2.1.1        withr_3.0.2         compiler_4.4.2     
#> [19] rstudioapi_0.17.1   tools_4.4.2         evaluate_1.0.3     
#> [22] yaml_2.3.10         S4Vectors_0.44.0    rlang_1.1.4        
#> [25] fs_1.6.5

Created on 2025-01-20 with reprex v2.1.1

@mikejiang
Copy link
Member

parameter descriptions is referring to "desc" column, which is marker/protein name

@SamGG
Copy link
Contributor Author

SamGG commented Jan 21, 2025

Hi Mike.
I don't get your point. My understanding is that the names() function/method should report the association of the name column and the desc column. IIRC, this was case at one moment, but not any more. Instead of " FSC-H", it should be " FSC-Height". Otherwise, I don't see the need of this function.
Best.

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

No branches or pull requests

2 participants