Skip to content

ActiveDataBio/CL_Create_Project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ADBio

CL_Create_Project

Command line program that generates the files for an Adbio data project repository.

Want to Contribute?

We welcome contibutions to this repository. Please refer to the Contributing Guide.

Using this program

###Requirements

  • Java 8
  • R

After setting up all requirements download CLCreateProject.jar. Refer to How to prepare for my data for instructions on how to... well prepare your data. When your data is prepared run the CLCreateProject.jar file by using

java -jar CLCreateProject.jar <Oganism abrivation e.g. hsa> <Destination path> <RData file path> <metadata.tsv path>

This will create all the required file in the destination folder. You will need to create a README.md file in this directory, use this template so the information in it will be parse properly and displayed correctly.

<!--adbio-title-->
<provide a title for your project>
<!--adbio-description-->
<provide a description for your project>
<!--adbio-funding-->
<!--adbio-publication-->
<!--adbio-organism-->
<provide an organism with this format>
Organism [<name to display in readme file e.g. Homo sapiens (human)>](<link to information about organism e.g. http://www.genome.jp/kegg-bin/show_organism?org=hsa>)
<!------------------------------------------------------------------------------>
<!--you can add any other information here-->

Next you need to create a repository on git and push this folder to it. You can also add a png file called icon.png to this repository, this will be displayed in the information for project. Then refer the Adbio repository to install the visual analytic tool to view your data.

## How to prepare for my data In order to create a new ADBio project using your own data, you need to prepare these two files.

  • RData file: it contains the data matrix and clustering information (See 'example data.RData')
  • Tab-delimited text file: it contains the meta data for each experiment (or each sample) (See 'example_metadata.tsv')

How to generate RData from my data file.

Please refer to this repository for instructions and tutorials to convert your data to a RData.

How to use a meta data file.

please go to here and refer to the tutorial.

About

Command line program that generates the files for a Adbio project repository

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors