Skip to content
This repository has been archived by the owner on Aug 20, 2024. It is now read-only.

Commit

Permalink
Merge pull request #17 from mirpedrol/update-readme
Browse files Browse the repository at this point in the history
update README
  • Loading branch information
mirpedrol authored May 5, 2023
2 parents 64f77b6 + ce29429 commit 0c7226c
Showing 1 changed file with 38 additions and 43 deletions.
81 changes: 38 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,48 +5,6 @@ based on [nf-core JSON schema](https://nf-co.re/pipeline_schema_builder).

It can also validate and convert a samplesheet to a Nextflow channel ready to use. Supported samplesheet formats are CSV, TSV and YAML (simple).

## Get started

To compile and run the tests use the following command:


```
./gradlew check
```


## Launch it with Nextflow

[WORK IN PROGRESS]

To test with Nextflow for development purpose:

1. Clone the Nextflow repo into a sibling directory

```
cd .. && https://github.com/nextflow-io/nextflow
cd nextflow && ./gradlew exportClasspath
```

2. Append to the `settings.gradle` in this project the following line:

```
includeBuild('../nextflow')
```

3. Compile the plugin code

```
./gradlew compileGroovy
```

4. run nextflow with this command:

```
./launch.sh run -plugins nf-validation <script/pipeline name> [pipeline params]
```


## Dependencies

* Java 11 or later
Expand Down Expand Up @@ -264,4 +222,41 @@ Channel.validateAndConvertSamplesheet(

For examples on how to process the created channel, see the [examples/](examples/) folder

<!--Note that in order to fully validate the sample sheet you must always run [`validateParameters()`](https://github.com/mirpedrol/nf-validation/blob/ce409583b4582f4221cbf0d0d3917e35f4ba628d/README.md#L116) with the [`schema` field provided](https://github.com/mirpedrol/nf-validation/blob/ce409583b4582f4221cbf0d0d3917e35f4ba628d/README.md#L200).-->
<!--Note that in order to fully validate the sample sheet you must always run [`validateParameters()`](https://github.com/mirpedrol/nf-validation/blob/ce409583b4582f4221cbf0d0d3917e35f4ba628d/README.md#L116) with the [`schema` field provided](https://github.com/mirpedrol/nf-validation/blob/ce409583b4582f4221cbf0d0d3917e35f4ba628d/README.md#L200).-->

# Getting started with plugin dev

To compile and run the tests use the following command:

```
./gradlew check
```

## Launch it with Nextflow

To test with Nextflow for development purpose:

1. Clone the Nextflow repo into a sibling directory

```
cd .. && https://github.com/nextflow-io/nextflow
cd nextflow && ./gradlew exportClasspath
```

2. Append to the `settings.gradle` in this project the following line:

```
includeBuild('../nextflow')
```

3. Compile the plugin code

```
./gradlew compileGroovy
```

4. run nextflow with this command:

```
./launch.sh run -plugins nf-validation <script/pipeline name> [pipeline params]
```

0 comments on commit 0c7226c

Please sign in to comment.