add a README file to a dataset

datalad.plugin.add_readme.dlplugin(dataset, filename='README.rst', existing='skip')[source]

Add basic information about DataLad datasets to a README file

The README file is added to the dataset and the addition is saved in the dataset.

  • dataset (Dataset) – dataset to add information to
  • filename (str, optional) – path of the README file within the dataset. Default: ‘README.rst’
  • existing ({'skip', 'append', 'replace'}) – how to react if a file with the target name already exists: ‘skip’: do nothing; ‘append’: append information to the existing file; ‘replace’: replace the existing file with new content. Default: ‘skip’