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

Update project README #4

Open
2 tasks done
enriquea opened this issue Jan 8, 2024 · 3 comments
Open
2 tasks done

Update project README #4

enriquea opened this issue Jan 8, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@enriquea
Copy link
Collaborator

enriquea commented Jan 8, 2024

  • Create a README file in the repository where the dataset format and structure are described.
    - The description should include the structure of the Tab-Separate Value (TSV) file as the primary dataset structure input.
    - The interface with Spark Data Frame for Feature Selection (internal data structure used by the tool).
  • Add to the README dataset file, the link to the Single-cell example we have been using for the benchmark of the algorithms.
    - Single-cell dataset: https://www.ncbi.nlm.nih.gov/geo/query/acc.cgi?acc=GSE156793
    - Include the formatted matrix used as input by the tool.
@ypriverol ypriverol added the documentation Improvements or additions to documentation label Jan 8, 2024
@enriquea
Copy link
Collaborator Author

enriquea commented Jan 9, 2024

@ypriverol Should we include the data description README (https://github.com/enriquea/fsspark/blob/main/README.data.md) in the project README?

@ypriverol
Copy link
Member

I think a section summarizing the README.data.md and the proper link to it would be OK.

@enriquea
Copy link
Collaborator Author

enriquea commented Feb 1, 2024

This issue also can be closed!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants